1 /* Cache handling for passwd lookup.
2 Copyright (C) 1998-2008, 2009, 2011, 2012 Free Software Foundation, Inc.
3 This file is part of the GNU C Library.
4 Contributed by Ulrich Drepper <drepper@cygnus.com>, 1998.
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published
8 by the Free Software Foundation; version 2 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, see <http://www.gnu.org/licenses/>. */
33 #include <sys/socket.h>
34 #include <stackinfo.h>
39 # include <kernel-features.h>
42 /* This is the standard reply in case the service is disabled. */
43 static const pw_response_header disabled
=
45 .version
= NSCD_VERSION
,
56 /* This is the struct describing how to write this record. */
57 const struct iovec pwd_iov_disabled
=
59 .iov_base
= (void *) &disabled
,
60 .iov_len
= sizeof (disabled
)
64 /* This is the standard reply in case we haven't found the dataset. */
65 static const pw_response_header notfound
=
67 .version
= NSCD_VERSION
,
80 cache_addpw (struct database_dyn
*db
, int fd
, request_header
*req
,
81 const void *key
, struct passwd
*pwd
, uid_t owner
,
82 struct hashentry
*const he
, struct datahead
*dh
, int errval
)
86 time_t t
= time (NULL
);
88 /* We allocate all data in one memory block: the iov vector,
89 the response header and the dataset itself. */
93 pw_response_header resp
;
97 assert (offsetof (struct dataset
, resp
) == offsetof (struct datahead
, data
));
99 time_t timeout
= MAX_TIMEOUT_VALUE
;
102 if (he
!= NULL
&& errval
== EAGAIN
)
104 /* If we have an old record available but cannot find one
105 now because the service is not available we keep the old
106 record and make sure it does not get removed. */
107 if (reload_count
!= UINT_MAX
&& dh
->nreloads
== reload_count
)
108 /* Do not reset the value if we never not reload the record. */
109 dh
->nreloads
= reload_count
- 1;
111 /* Reload with the same time-to-live value. */
112 timeout
= dh
->timeout
= t
+ db
->postimeout
;
118 /* We have no data. This means we send the standard reply for this
120 written
= total
= sizeof (notfound
);
123 written
= TEMP_FAILURE_RETRY (send (fd
, ¬found
, total
,
126 /* If we have a transient error or cannot permanently store
127 the result, so be it. */
128 if (errno
== EAGAIN
|| __builtin_expect (db
->negtimeout
== 0, 0))
130 /* Mark the old entry as obsolete. */
134 else if ((dataset
= mempool_alloc (db
, (sizeof (struct dataset
)
135 + req
->key_len
), 1)) != NULL
)
137 dataset
->head
.allocsize
= sizeof (struct dataset
) + req
->key_len
;
138 dataset
->head
.recsize
= total
;
139 dataset
->head
.notfound
= true;
140 dataset
->head
.nreloads
= 0;
141 dataset
->head
.usable
= true;
143 /* Compute the timeout time. */
144 timeout
= dataset
->head
.timeout
= t
+ db
->negtimeout
;
146 /* This is the reply. */
147 memcpy (&dataset
->resp
, ¬found
, total
);
149 /* Copy the key data. */
150 char *key_copy
= memcpy (dataset
->strdata
, key
, req
->key_len
);
152 /* If necessary, we also propagate the data to disk. */
156 uintptr_t pval
= (uintptr_t) dataset
& ~pagesize_m1
;
157 msync ((void *) pval
,
158 ((uintptr_t) dataset
& pagesize_m1
)
159 + sizeof (struct dataset
) + req
->key_len
, MS_ASYNC
);
162 (void) cache_add (req
->type
, key_copy
, req
->key_len
,
163 &dataset
->head
, true, db
, owner
, he
== NULL
);
165 pthread_rwlock_unlock (&db
->lock
);
167 /* Mark the old entry as obsolete. */
175 /* Determine the I/O structure. */
176 size_t pw_name_len
= strlen (pwd
->pw_name
) + 1;
177 size_t pw_passwd_len
= strlen (pwd
->pw_passwd
) + 1;
178 size_t pw_gecos_len
= strlen (pwd
->pw_gecos
) + 1;
179 size_t pw_dir_len
= strlen (pwd
->pw_dir
) + 1;
180 size_t pw_shell_len
= strlen (pwd
->pw_shell
) + 1;
182 const size_t key_len
= strlen (key
);
183 const size_t buf_len
= 3 * sizeof (pwd
->pw_uid
) + key_len
+ 1;
184 char *buf
= alloca (buf_len
);
187 /* We need this to insert the `byuid' entry. */
189 n
= snprintf (buf
, buf_len
, "%d%c%n%s", pwd
->pw_uid
, '\0',
190 &key_offset
, (char *) key
) + 1;
192 written
= total
= (offsetof (struct dataset
, strdata
)
193 + pw_name_len
+ pw_passwd_len
194 + pw_gecos_len
+ pw_dir_len
+ pw_shell_len
);
196 /* If we refill the cache, first assume the reconrd did not
197 change. Allocate memory on the cache since it is likely
198 discarded anyway. If it turns out to be necessary to have a
199 new record we can still allocate real memory. */
200 bool alloca_used
= false;
204 dataset
= (struct dataset
*) mempool_alloc (db
, total
+ n
, 1);
208 /* We cannot permanently add the result in the moment. But
209 we can provide the result as is. Store the data in some
211 dataset
= (struct dataset
*) alloca (total
+ n
);
213 /* We cannot add this record to the permanent database. */
217 dataset
->head
.allocsize
= total
+ n
;
218 dataset
->head
.recsize
= total
- offsetof (struct dataset
, resp
);
219 dataset
->head
.notfound
= false;
220 dataset
->head
.nreloads
= he
== NULL
? 0 : (dh
->nreloads
+ 1);
221 dataset
->head
.usable
= true;
223 /* Compute the timeout time. */
224 timeout
= dataset
->head
.timeout
= t
+ db
->postimeout
;
226 dataset
->resp
.version
= NSCD_VERSION
;
227 dataset
->resp
.found
= 1;
228 dataset
->resp
.pw_name_len
= pw_name_len
;
229 dataset
->resp
.pw_passwd_len
= pw_passwd_len
;
230 dataset
->resp
.pw_uid
= pwd
->pw_uid
;
231 dataset
->resp
.pw_gid
= pwd
->pw_gid
;
232 dataset
->resp
.pw_gecos_len
= pw_gecos_len
;
233 dataset
->resp
.pw_dir_len
= pw_dir_len
;
234 dataset
->resp
.pw_shell_len
= pw_shell_len
;
236 cp
= dataset
->strdata
;
238 /* Copy the strings over into the buffer. */
239 cp
= mempcpy (cp
, pwd
->pw_name
, pw_name_len
);
240 cp
= mempcpy (cp
, pwd
->pw_passwd
, pw_passwd_len
);
241 cp
= mempcpy (cp
, pwd
->pw_gecos
, pw_gecos_len
);
242 cp
= mempcpy (cp
, pwd
->pw_dir
, pw_dir_len
);
243 cp
= mempcpy (cp
, pwd
->pw_shell
, pw_shell_len
);
245 /* Finally the stringified UID value. */
247 char *key_copy
= cp
+ key_offset
;
248 assert (key_copy
== (char *) rawmemchr (cp
, '\0') + 1);
250 assert (cp
== dataset
->strdata
+ total
- offsetof (struct dataset
,
253 /* Now we can determine whether on refill we have to create a new
259 if (dataset
->head
.allocsize
== dh
->allocsize
260 && dataset
->head
.recsize
== dh
->recsize
261 && memcmp (&dataset
->resp
, dh
->data
,
262 dh
->allocsize
- offsetof (struct dataset
, resp
)) == 0)
264 /* The data has not changed. We will just bump the
265 timeout value. Note that the new record has been
266 allocated on the stack and need not be freed. */
267 dh
->timeout
= dataset
->head
.timeout
;
272 /* We have to create a new record. Just allocate
273 appropriate memory and copy it. */
275 = (struct dataset
*) mempool_alloc (db
, total
+ n
, 1);
278 /* Adjust pointer into the memory block. */
279 cp
= (char *) newp
+ (cp
- (char *) dataset
);
280 key_copy
= (char *) newp
+ (key_copy
- (char *) dataset
);
282 dataset
= memcpy (newp
, dataset
, total
+ n
);
286 /* Mark the old record as obsolete. */
292 /* We write the dataset before inserting it to the database
293 since while inserting this thread might block and so would
294 unnecessarily let the receiver wait. */
298 if (__builtin_expect (db
->mmap_used
, 1) && !alloca_used
)
300 assert (db
->wr_fd
!= -1);
301 assert ((char *) &dataset
->resp
> (char *) db
->data
);
302 assert ((char *) dataset
- (char *) db
->head
304 <= (sizeof (struct database_pers_head
)
305 + db
->head
->module
* sizeof (ref_t
)
306 + db
->head
->data_size
));
307 written
= sendfileall (fd
, db
->wr_fd
,
308 (char *) &dataset
->resp
309 - (char *) db
->head
, dataset
->head
.recsize
);
310 # ifndef __ASSUME_SENDFILE
311 if (written
== -1 && errno
== ENOSYS
)
316 # ifndef __ASSUME_SENDFILE
320 written
= writeall (fd
, &dataset
->resp
, dataset
->head
.recsize
);
324 /* Add the record to the database. But only if it has not been
325 stored on the stack. */
328 /* If necessary, we also propagate the data to disk. */
332 uintptr_t pval
= (uintptr_t) dataset
& ~pagesize_m1
;
333 msync ((void *) pval
,
334 ((uintptr_t) dataset
& pagesize_m1
) + total
+ n
,
338 /* NB: in the following code we always must add the entry
339 marked with FIRST first. Otherwise we end up with
340 dangling "pointers" in case a latter hash entry cannot be
344 /* If the request was by UID, add that entry first. */
345 if (req
->type
== GETPWBYUID
)
347 if (cache_add (GETPWBYUID
, cp
, key_offset
, &dataset
->head
, true,
348 db
, owner
, he
== NULL
) < 0)
353 /* If the key is different from the name add a separate entry. */
354 else if (strcmp (key_copy
, dataset
->strdata
) != 0)
356 if (cache_add (GETPWBYNAME
, key_copy
, key_len
+ 1,
357 &dataset
->head
, true, db
, owner
, he
== NULL
) < 0)
363 /* We have to add the value for both, byname and byuid. */
364 if ((req
->type
== GETPWBYNAME
|| db
->propagate
)
365 && __builtin_expect (cache_add (GETPWBYNAME
, dataset
->strdata
,
366 pw_name_len
, &dataset
->head
,
367 first
, db
, owner
, he
== NULL
)
370 if (req
->type
== GETPWBYNAME
&& db
->propagate
)
371 (void) cache_add (GETPWBYUID
, cp
, key_offset
, &dataset
->head
,
372 false, db
, owner
, false);
376 pthread_rwlock_unlock (&db
->lock
);
380 if (__builtin_expect (written
!= total
, 0) && debug_level
> 0)
383 dbg_log (_("short write in %s: %s"), __FUNCTION__
,
384 strerror_r (errno
, buf
, sizeof (buf
)));
399 lookup (int type
, union keytype key
, struct passwd
*resultbufp
, char *buffer
,
400 size_t buflen
, struct passwd
**pwd
)
402 if (type
== GETPWBYNAME
)
403 return __getpwnam_r (key
.v
, resultbufp
, buffer
, buflen
, pwd
);
405 return __getpwuid_r (key
.u
, resultbufp
, buffer
, buflen
, pwd
);
410 addpwbyX (struct database_dyn
*db
, int fd
, request_header
*req
,
411 union keytype key
, const char *keystr
, uid_t c_uid
,
412 struct hashentry
*he
, struct datahead
*dh
)
414 /* Search for the entry matching the key. Please note that we don't
415 look again in the table whether the dataset is now available. We
416 simply insert it. It does not matter if it is in there twice. The
417 pruning function only will look at the timestamp. */
418 size_t buflen
= 1024;
419 char *buffer
= (char *) alloca (buflen
);
420 struct passwd resultbuf
;
422 bool use_malloc
= false;
425 if (__builtin_expect (debug_level
> 0, 0))
428 dbg_log (_("Haven't found \"%s\" in password cache!"), keystr
);
430 dbg_log (_("Reloading \"%s\" in password cache!"), keystr
);
433 while (lookup (req
->type
, key
, &resultbuf
, buffer
, buflen
, &pwd
) != 0
434 && (errval
= errno
) == ERANGE
)
438 if (__builtin_expect (buflen
> 32768, 0))
440 char *old_buffer
= buffer
;
442 buffer
= (char *) realloc (use_malloc
? buffer
: NULL
, buflen
);
445 /* We ran out of memory. We cannot do anything but
446 sending a negative response. In reality this should
451 /* We set the error to indicate this is (possibly) a
452 temporary error and that it does not mean the entry
453 is not available at all. */
460 /* Allocate a new buffer on the stack. If possible combine it
461 with the previously allocated buffer. */
462 buffer
= (char *) extend_alloca (buffer
, buflen
, 2 * buflen
);
465 /* Add the entry to the cache. */
466 time_t timeout
= cache_addpw (db
, fd
, req
, keystr
, pwd
, c_uid
, he
, dh
,
477 addpwbyname (struct database_dyn
*db
, int fd
, request_header
*req
,
478 void *key
, uid_t c_uid
)
480 union keytype u
= { .v
= key
};
482 addpwbyX (db
, fd
, req
, u
, key
, c_uid
, NULL
, NULL
);
487 readdpwbyname (struct database_dyn
*db
, struct hashentry
*he
,
495 union keytype u
= { .v
= db
->data
+ he
->key
};
497 return addpwbyX (db
, -1, &req
, u
, db
->data
+ he
->key
, he
->owner
, he
, dh
);
502 addpwbyuid (struct database_dyn
*db
, int fd
, request_header
*req
,
503 void *key
, uid_t c_uid
)
506 uid_t uid
= strtoul ((char *) key
, &ep
, 10);
508 if (*(char *) key
== '\0' || *ep
!= '\0') /* invalid numeric uid */
511 dbg_log (_("Invalid numeric uid \"%s\"!"), (char *) key
);
517 union keytype u
= { .u
= uid
};
519 addpwbyX (db
, fd
, req
, u
, key
, c_uid
, NULL
, NULL
);
524 readdpwbyuid (struct database_dyn
*db
, struct hashentry
*he
,
528 uid_t uid
= strtoul (db
->data
+ he
->key
, &ep
, 10);
530 /* Since the key has been added before it must be OK. */
531 assert (*(db
->data
+ he
->key
) != '\0' && *ep
== '\0');
538 union keytype u
= { .u
= uid
};
540 return addpwbyX (db
, -1, &req
, u
, db
->data
+ he
->key
, he
->owner
, he
, dh
);