2 * Copyright (c) 2009, Sun Microsystems, Inc.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 * - Redistributions of source code must retain the above copyright notice,
8 * this list of conditions and the following disclaimer.
9 * - Redistributions in binary form must reproduce the above copyright notice,
10 * this list of conditions and the following disclaimer in the documentation
11 * and/or other materials provided with the distribution.
12 * - Neither the name of Sun Microsystems, Inc. nor the names of its
13 * contributors may be used to endorse or promote products derived
14 * from this software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
29 * Copyright (c) 1988 by Sun Microsystems, Inc.
32 * auth_des.c, client-side implementation of DES authentication
35 #include <reentrant.h>
41 #include <sys/cdefs.h>
42 #include <rpc/des_crypt.h>
44 #include <rpc/types.h>
46 #include <rpc/auth_des.h>
49 #include <sys/socket.h>
51 #include <rpcsvc/nis.h>
53 #if defined(LIBC_SCCS) && !defined(lint)
55 #include <sys/cdefs.h>
57 #define USEC_PER_SEC 1000000
58 #define RTIME_TIMEOUT 5 /* seconds to wait for sync */
60 #define AUTH_PRIVATE(auth) (struct ad_private *) auth->ah_private
61 #define ALLOC(object_type) (object_type *) mem_alloc(sizeof(object_type))
62 #define FREE(ptr, size) mem_free((char *)(ptr), (int) size)
63 #define ATTEMPT(xdr_op) if (!(xdr_op)) return (FALSE)
65 extern bool_t xdr_authdes_cred( XDR *, struct authdes_cred *);
66 extern bool_t xdr_authdes_verf( XDR *, struct authdes_verf *);
67 extern int key_encryptsession_pk();
69 extern bool_t __rpc_get_time_offset(struct timeval *, nis_server *, char *,
73 * DES authenticator operations vector
75 static void authdes_nextverf(AUTH *);
76 static bool_t authdes_marshal(AUTH *, XDR *);
77 static bool_t authdes_validate(AUTH *, struct opaque_auth *);
78 static bool_t authdes_refresh(AUTH *, void *);
79 static void authdes_destroy(AUTH *);
81 static struct auth_ops *authdes_ops(void);
84 * This struct is pointed to by the ah_private field of an "AUTH *"
87 char *ad_fullname; /* client's full name */
88 u_int ad_fullnamelen; /* length of name, rounded up */
89 char *ad_servername; /* server's full name */
90 u_int ad_servernamelen; /* length of name, rounded up */
91 u_int ad_window; /* client specified window */
92 bool_t ad_dosync; /* synchronize? */
93 struct netbuf ad_syncaddr; /* remote host to synch with */
94 char *ad_timehost; /* remote host to synch with */
95 struct timeval ad_timediff; /* server's time - client's time */
96 u_int ad_nickname; /* server's nickname for client */
97 struct authdes_cred ad_cred; /* storage for credential */
98 struct authdes_verf ad_verf; /* storage for verifier */
99 struct timeval ad_timestamp; /* timestamp sent */
100 des_block ad_xkey; /* encrypted conversation key */
101 u_char ad_pkey[1024]; /* Server's actual public key */
102 char *ad_netid; /* Timehost netid */
103 char *ad_uaddr; /* Timehost uaddr */
104 nis_server *ad_nis_srvr; /* NIS+ server struct */
107 AUTH *authdes_pk_seccreate(const char *, netobj *, u_int, const char *,
108 const des_block *, nis_server *);
111 * documented version of authdes_seccreate
114 servername: network name of server
116 timehost: optional hostname to sync with
117 ckey: optional conversation key to use
121 authdes_seccreate(const char *servername, const u_int win,
122 const char *timehost, const des_block *ckey)
124 u_char pkey_data[1024];
128 if (! getpublickey(servername, (char *) pkey_data)) {
130 "authdes_seccreate: no public key found for %s",
135 pkey.n_bytes = (char *) pkey_data;
136 pkey.n_len = (u_int)strlen((char *)pkey_data) + 1;
137 dummy = authdes_pk_seccreate(servername, &pkey, win, timehost,
143 * Slightly modified version of authdessec_create which takes the public key
144 * of the server principal as an argument. This spares us a call to
145 * getpublickey() which in the nameserver context can cause a deadlock.
148 authdes_pk_seccreate(const char *servername, netobj *pkey, u_int window,
149 const char *timehost, const des_block *ckey, nis_server *srvr)
152 struct ad_private *ad;
153 char namebuf[MAXNETNAMELEN+1];
156 * Allocate everything now
160 syslog(LOG_ERR, "authdes_pk_seccreate: out of memory");
163 ad = ALLOC(struct ad_private);
165 syslog(LOG_ERR, "authdes_pk_seccreate: out of memory");
168 ad->ad_fullname = ad->ad_servername = NULL; /* Sanity reasons */
169 ad->ad_timehost = NULL;
172 ad->ad_nis_srvr = NULL;
173 ad->ad_timediff.tv_sec = 0;
174 ad->ad_timediff.tv_usec = 0;
175 memcpy(ad->ad_pkey, pkey->n_bytes, pkey->n_len);
176 if (!getnetname(namebuf))
178 ad->ad_fullnamelen = RNDUP((u_int) strlen(namebuf));
179 ad->ad_fullname = (char *)mem_alloc(ad->ad_fullnamelen + 1);
180 ad->ad_servernamelen = strlen(servername);
181 ad->ad_servername = (char *)mem_alloc(ad->ad_servernamelen + 1);
183 if (ad->ad_fullname == NULL || ad->ad_servername == NULL) {
184 syslog(LOG_ERR, "authdes_seccreate: out of memory");
187 if (timehost != NULL) {
188 ad->ad_timehost = (char *)mem_alloc(strlen(timehost) + 1);
189 if (ad->ad_timehost == NULL) {
190 syslog(LOG_ERR, "authdes_seccreate: out of memory");
193 memcpy(ad->ad_timehost, timehost, strlen(timehost) + 1);
194 ad->ad_dosync = TRUE;
195 } else if (srvr != NULL) {
196 ad->ad_nis_srvr = srvr; /* transient */
197 ad->ad_dosync = TRUE;
199 ad->ad_dosync = FALSE;
201 memcpy(ad->ad_fullname, namebuf, ad->ad_fullnamelen + 1);
202 memcpy(ad->ad_servername, servername, ad->ad_servernamelen + 1);
203 ad->ad_window = window;
205 if (key_gendes(&auth->ah_key) < 0) {
207 "authdes_seccreate: keyserv(1m) is unable to generate session key");
211 auth->ah_key = *ckey;
217 auth->ah_cred.oa_flavor = AUTH_DES;
218 auth->ah_verf.oa_flavor = AUTH_DES;
219 auth->ah_ops = authdes_ops();
220 auth->ah_private = (caddr_t)ad;
222 if (!authdes_refresh(auth, NULL)) {
225 ad->ad_nis_srvr = NULL; /* not needed any longer */
230 FREE(auth, sizeof (AUTH));
233 FREE(ad->ad_fullname, ad->ad_fullnamelen + 1);
234 if (ad->ad_servername)
235 FREE(ad->ad_servername, ad->ad_servernamelen + 1);
237 FREE(ad->ad_timehost, strlen(ad->ad_timehost) + 1);
239 FREE(ad->ad_netid, strlen(ad->ad_netid) + 1);
241 FREE(ad->ad_uaddr, strlen(ad->ad_uaddr) + 1);
242 FREE(ad, sizeof (struct ad_private));
248 * Implement the five authentication operations
257 authdes_nextverf(AUTH *auth)
259 /* what the heck am I supposed to do??? */
267 authdes_marshal(AUTH *auth, XDR *xdrs)
269 /* LINTED pointer alignment */
270 struct ad_private *ad = AUTH_PRIVATE(auth);
271 struct authdes_cred *cred = &ad->ad_cred;
272 struct authdes_verf *verf = &ad->ad_verf;
273 des_block cryptbuf[2];
280 * Figure out the "time", accounting for any time difference
281 * with the server if necessary.
283 (void) gettimeofday(&ad->ad_timestamp, (struct timezone *)NULL);
284 ad->ad_timestamp.tv_sec += ad->ad_timediff.tv_sec;
285 ad->ad_timestamp.tv_usec += ad->ad_timediff.tv_usec;
286 while (ad->ad_timestamp.tv_usec >= USEC_PER_SEC) {
287 ad->ad_timestamp.tv_usec -= USEC_PER_SEC;
288 ad->ad_timestamp.tv_sec++;
292 * XDR the timestamp and possibly some other things, then
295 ixdr = (rpc_inline_t *)cryptbuf;
296 IXDR_PUT_INT32(ixdr, ad->ad_timestamp.tv_sec);
297 IXDR_PUT_INT32(ixdr, ad->ad_timestamp.tv_usec);
298 if (ad->ad_cred.adc_namekind == ADN_FULLNAME) {
299 IXDR_PUT_U_INT32(ixdr, ad->ad_window);
300 IXDR_PUT_U_INT32(ixdr, ad->ad_window - 1);
301 ivec.key.high = ivec.key.low = 0;
302 status = cbc_crypt((char *)&auth->ah_key, (char *)cryptbuf,
303 (u_int) 2 * sizeof (des_block),
304 DES_ENCRYPT | DES_HW, (char *)&ivec);
306 status = ecb_crypt((char *)&auth->ah_key, (char *)cryptbuf,
307 (u_int) sizeof (des_block),
308 DES_ENCRYPT | DES_HW);
310 if (DES_FAILED(status)) {
311 syslog(LOG_ERR, "authdes_marshal: DES encryption failure");
314 ad->ad_verf.adv_xtimestamp = cryptbuf[0];
315 if (ad->ad_cred.adc_namekind == ADN_FULLNAME) {
316 ad->ad_cred.adc_fullname.window = cryptbuf[1].key.high;
317 ad->ad_verf.adv_winverf = cryptbuf[1].key.low;
319 ad->ad_cred.adc_nickname = ad->ad_nickname;
320 ad->ad_verf.adv_winverf = 0;
324 * Serialize the credential and verifier into opaque
325 * authentication data.
327 if (ad->ad_cred.adc_namekind == ADN_FULLNAME) {
328 len = ((1 + 1 + 2 + 1)*BYTES_PER_XDR_UNIT + ad->ad_fullnamelen);
330 len = (1 + 1)*BYTES_PER_XDR_UNIT;
333 if ((ixdr = xdr_inline(xdrs, 2*BYTES_PER_XDR_UNIT))) {
334 IXDR_PUT_INT32(ixdr, AUTH_DES);
335 IXDR_PUT_INT32(ixdr, len);
337 ATTEMPT(xdr_putint32(xdrs, (int *)&auth->ah_cred.oa_flavor));
338 ATTEMPT(xdr_putint32(xdrs, &len));
340 ATTEMPT(xdr_authdes_cred(xdrs, cred));
342 len = (2 + 1)*BYTES_PER_XDR_UNIT;
343 if ((ixdr = xdr_inline(xdrs, 2*BYTES_PER_XDR_UNIT))) {
344 IXDR_PUT_INT32(ixdr, AUTH_DES);
345 IXDR_PUT_INT32(ixdr, len);
347 ATTEMPT(xdr_putint32(xdrs, (int *)&auth->ah_verf.oa_flavor));
348 ATTEMPT(xdr_putint32(xdrs, &len));
350 ATTEMPT(xdr_authdes_verf(xdrs, verf));
359 authdes_validate(AUTH *auth, struct opaque_auth *rverf)
361 /* LINTED pointer alignment */
362 struct ad_private *ad = AUTH_PRIVATE(auth);
363 struct authdes_verf verf;
368 if (rverf->oa_length != (2 + 1) * BYTES_PER_XDR_UNIT) {
371 /* LINTED pointer alignment */
372 ixdr = (uint32_t *)rverf->oa_base;
373 buf.key.high = (uint32_t)*ixdr++;
374 buf.key.low = (uint32_t)*ixdr++;
375 verf.adv_int_u = (uint32_t)*ixdr++;
378 * Decrypt the timestamp
380 status = ecb_crypt((char *)&auth->ah_key, (char *)&buf,
381 (u_int)sizeof (des_block), DES_DECRYPT | DES_HW);
383 if (DES_FAILED(status)) {
384 syslog(LOG_ERR, "authdes_validate: DES decryption failure");
389 * xdr the decrypted timestamp
391 /* LINTED pointer alignment */
392 ixdr = (uint32_t *)buf.c;
393 verf.adv_timestamp.tv_sec = IXDR_GET_INT32(ixdr) + 1;
394 verf.adv_timestamp.tv_usec = IXDR_GET_INT32(ixdr);
399 if (bcmp((char *)&ad->ad_timestamp, (char *)&verf.adv_timestamp,
400 sizeof(struct timeval)) != 0) {
401 syslog(LOG_DEBUG, "authdes_validate: verifier mismatch");
406 * We have a nickname now, let's use it
408 ad->ad_nickname = verf.adv_nickname;
409 ad->ad_cred.adc_namekind = ADN_NICKNAME;
418 authdes_refresh(AUTH *auth, void *dummy)
420 /* LINTED pointer alignment */
421 struct ad_private *ad = AUTH_PRIVATE(auth);
422 struct authdes_cred *cred = &ad->ad_cred;
427 ok = __rpc_get_time_offset(&ad->ad_timediff, ad->ad_nis_srvr,
428 ad->ad_timehost, &(ad->ad_uaddr),
432 * Hope the clocks are synced!
436 "authdes_refresh: unable to synchronize clock");
439 ad->ad_xkey = auth->ah_key;
440 pkey.n_bytes = (char *)(ad->ad_pkey);
441 pkey.n_len = (u_int)strlen((char *)ad->ad_pkey) + 1;
442 if (key_encryptsession_pk(ad->ad_servername, &pkey, &ad->ad_xkey) < 0) {
444 "authdes_refresh: keyserv(1m) is unable to encrypt session key");
447 cred->adc_fullname.key = ad->ad_xkey;
448 cred->adc_namekind = ADN_FULLNAME;
449 cred->adc_fullname.name = ad->ad_fullname;
458 authdes_destroy(AUTH *auth)
460 /* LINTED pointer alignment */
461 struct ad_private *ad = AUTH_PRIVATE(auth);
463 FREE(ad->ad_fullname, ad->ad_fullnamelen + 1);
464 FREE(ad->ad_servername, ad->ad_servernamelen + 1);
466 FREE(ad->ad_timehost, strlen(ad->ad_timehost) + 1);
468 FREE(ad->ad_netid, strlen(ad->ad_netid) + 1);
470 FREE(ad->ad_uaddr, strlen(ad->ad_uaddr) + 1);
471 FREE(ad, sizeof (struct ad_private));
472 FREE(auth, sizeof(AUTH));
475 static struct auth_ops *
478 static struct auth_ops ops;
479 extern mutex_t authdes_ops_lock;
481 /* VARIABLES PROTECTED BY ops_lock: ops */
483 mutex_lock(&authdes_ops_lock);
484 if (ops.ah_nextverf == NULL) {
485 ops.ah_nextverf = authdes_nextverf;
486 ops.ah_marshal = authdes_marshal;
487 ops.ah_validate = authdes_validate;
488 ops.ah_refresh = authdes_refresh;
489 ops.ah_destroy = authdes_destroy;
491 mutex_unlock(&authdes_ops_lock);