1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
|
/*
common.h - common functions for NSS lookups
Copyright (C) 2006 West Consulting
Copyright (C) 2006, 2007 Arthur de Jong
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA
*/
#ifndef _NSS_COMMON_H
#define _NSS_COMMON_H 1
#include <stdio.h>
#include <nss.h>
#include "nslcd.h"
#include "nslcd-common.h"
#include "compat/attrs.h"
#include "common/tio.h"
/* This function maps an nslcd return code (as defined in nslcd.h)
to an nss code (as defined in nss.h). */
enum nss_status nslcd2nss(int32_t code);
/* returns a socket to the server or NULL on error (see errno),
socket should be closed with tio_close() */
TFILE *nslcd_client_open(void)
MUST_USE;
/* These are macors for performing common operations in the nslcd
request/response protocol, they are an extension for client
applications to the macros defined in nslcd-common.h. */
/* Open a client socket. */
#define OPEN_SOCK(fp) \
if ((fp=nslcd_client_open())==NULL) \
{ ERROR_OUT_OPENERROR }
/* Write a request header with a request code. */
#define WRITE_REQUEST(fp,req) \
WRITE_INT32(fp,(int32_t)NSLCD_VERSION) \
WRITE_INT32(fp,(int32_t)req)
/* Read a response header and check that the returned request
code equals the expected code. */
#define READ_RESPONSEHEADER(fp,req) \
READ_TYPE(fp,tmpint32,int32_t); \
if (tmpint32!=(int32_t)NSLCD_VERSION) \
{ ERROR_OUT_READERROR(fp) } \
READ_TYPE(fp,tmpint32,int32_t); \
if (tmpint32!=(int32_t)(req)) \
{ ERROR_OUT_READERROR(fp) }
/* Read the response code (the result code of the query) from
the stream. */
#define READ_RESPONSE_CODE(fp) \
READ_TYPE(fp,tmpint32,int32_t); \
if (tmpint32!=(int32_t)NSLCD_RESULT_SUCCESS) \
{ ERROR_OUT_NOSUCCESS(fp,tmpint32) }
/* These are macros for handling read and write problems, they are
NSS specific due to the return code so are defined here. They
genrally close the open file, set an error code and return with
an error status. */
/* Macro is called to handle errors in opening a client connection. */
#define ERROR_OUT_OPENERROR \
*errnop=ENOENT; \
return (errno==EAGAIN)?NSS_STATUS_TRYAGAIN:NSS_STATUS_UNAVAIL;
/* Macro is called to handle errors on read operations. */
#define ERROR_OUT_READERROR(fp) \
(void)tio_close(fp); \
fp=NULL; \
*errnop=ENOENT; \
return NSS_STATUS_UNAVAIL;
/* Macro is called to handle problems with too small a buffer.
Note that this currently requires the caller to do setent()
again before doing getent() because this closes the stream.
Something more inteligent (e.g. ungetting the read data from
the stream) should be implemented. */
#define ERROR_OUT_BUFERROR(fp) \
(void)tio_close(fp); \
fp=NULL; \
*errnop=ERANGE; \
return NSS_STATUS_TRYAGAIN;
/* This macro is called if there was a problem with a write
operation. */
#define ERROR_OUT_WRITEERROR(fp) \
ERROR_OUT_READERROR(fp)
/* This macro is called if the read status code is not
NSLCD_RESULT_SUCCESS. */
#define ERROR_OUT_NOSUCCESS(fp,retv) \
(void)tio_close(fp); \
fp=NULL; \
*errnop=ENOENT; \
return nslcd2nss(retv);
/* The following macros to automatically generate get..byname(),
get..bynumber(), setent(), getent() and endent() function
bodies. These functions have very common code so this can
easily be reused. */
/* This is a generic get..by..() generation macro. The action
parameter is the NSLCD_ACTION_.. action, the param is the
operation for writing the parameter and readfn is the function
name for reading a single result entry. The function is assumed
to have result, buffer, buflen and errnop parameters that define
the result structure, the user buffer with length and the
errno to return. This macro should be called through some of
the customized ones below. */
#define NSS_BYGEN(action,param,readfn) \
TFILE *fp; \
int32_t tmpint32; \
enum nss_status retv; \
/* open socket and write request */ \
OPEN_SOCK(fp); \
WRITE_REQUEST(fp,action); \
param; \
WRITE_FLUSH(fp); \
/* read response header */ \
READ_RESPONSEHEADER(fp,action); \
/* read response */ \
READ_RESPONSE_CODE(fp); \
retv=readfn; \
/* close socket and we're done */ \
if (retv==NSS_STATUS_SUCCESS) \
(void)tio_close(fp); \
return retv;
/* This macro can be used to generate a get..byname() function
body. */
#define NSS_BYNAME(action,name,readfn) \
NSS_BYGEN(action,WRITE_STRING(fp,name),readfn)
/* This macro can be used to generate a get..by..() function
body where the value that is the key has the specified type. */
#define NSS_BYTYPE(action,val,type,readfn) \
NSS_BYGEN(action,WRITE_TYPE(fp,val,type),readfn)
/* This macro can be used to generate a get..by..() function
body where the value should be passed as an int32_t. */
#define NSS_BYINT32(action,val,readfn) \
NSS_BYGEN(action,WRITE_INT32(fp,val),readfn)
/* This macro generates a simple setent() function body. A stream
is opened, a request is written and a check is done for
a response header. */
#define NSS_SETENT(fp,action) \
int32_t tmpint32; \
int errnocp; \
int *errnop; \
errnop=&errnocp; \
/* close the existing stream if it is still open */ \
if (fp!=NULL) \
(void)tio_close(fp); \
/* open a new stream and write the request */ \
OPEN_SOCK(fp); \
WRITE_REQUEST(fp,action); \
WRITE_FLUSH(fp); \
/* read response header */ \
READ_RESPONSEHEADER(fp,action); \
return NSS_STATUS_SUCCESS;
/* This macro generates a getent() function body. A single entry
is read with the readfn() function. */
#define NSS_GETENT(fp,readfn) \
int32_t tmpint32; \
enum nss_status retv; \
/* check that we have a valid file descriptor */ \
if (fp==NULL) \
{ \
*errnop=ENOENT; \
return NSS_STATUS_UNAVAIL; \
} \
/* read a response */ \
READ_RESPONSE_CODE(fp); \
retv=readfn; \
/* check read result */ \
if (retv!=NSS_STATUS_SUCCESS) \
fp=NULL; /* file should be closed by now */ \
return retv;
/* This macro generates a endent() function body. This just closes
the stream. */
#define NSS_ENDENT(fp) \
if (fp!=NULL) \
{ \
(void)tio_close(fp); \
fp=NULL; \
} \
return NSS_STATUS_SUCCESS;
#endif /* not _NSS_COMMON_H */
|