2 * Copyright 2000, International Business Machines Corporation and others.
5 * This software has been released under the terms of the IBM Public
6 * License. For details, see the LICENSE file in the top-level source
7 * directory or online at http://www.openafs.org/dl/license10.html
10 /* The rxkad security object. Routines used by both client and servers. */
12 #include <afsconfig.h>
14 #include "afs/param.h"
16 #include <afs/param.h>
20 #include <sys/time_impl.h>
23 #define INCLUDE_RXKAD_PRIVATE_DECLS
31 #include "afs/afs_osi.h"
35 #if defined(AFS_DARWIN60_ENV) || defined(AFS_OBSD_ENV)
40 #ifndef AFS_LINUX22_ENV
41 #include "rpc/types.h"
43 #endif /* AFS_LINUX22_ENV */
45 #include "afs/sysincludes.h"
46 #include "afsincludes.h"
52 #include <sys/types.h>
56 #ifdef AFS_PTHREAD_ENV
57 #define RXKAD_STATS_DECLSPEC __declspec(dllexport)
60 #include <netinet/in.h>
74 #include <des/stats.h>
75 #include "private_data.h"
76 #define XPRT_RXKAD_COMMON
79 #define afs_max(a,b) ((a) < (b)? (b) : (a))
83 #define osi_Time() time(0)
85 /* variable initialization for the benefit of darwin compiler; if it causes
86 problems elsewhere, conditionalize for darwin or fc_test compile breaks */
87 #ifdef AFS_PTHREAD_ENV
88 struct rxkad_global_stats rxkad_global_stats = { 0 };
89 pthread_mutex_t rxkad_global_stats_lock;
90 pthread_key_t rxkad_stats_key;
91 #else /* AFS_PTHREAD_ENV */
92 struct rxkad_stats rxkad_stats = { { 0 } };
93 #endif /* AFS_PTHREAD_ENV */
95 #ifdef AFS_PTHREAD_ENV
96 /* rxkad_stats related stuff */
99 * Macro to insert an element at the tail of a doubly linked list
101 #define DLL_INSERT_TAIL(ptr,head,tail,next,prev) \
103 (ptr)->next = NULL; \
104 (ptr)->prev = (tail); \
107 (ptr)->prev->next = (ptr); \
110 assert((head) && ((head)->prev == NULL)); \
113 void rxkad_global_stats_init() {
114 assert(pthread_mutex_init(&rxkad_global_stats_lock, (const pthread_mutexattr_t *)0) == 0);
115 assert(pthread_key_create(&rxkad_stats_key, NULL) == 0);
116 memset(&rxkad_global_stats, 0, sizeof(rxkad_global_stats));
120 rxkad_thr_stats_init() {
121 rxkad_stats_t * rxkad_stats;
122 rxkad_stats = (rxkad_stats_t *)malloc(sizeof(rxkad_stats_t));
123 assert(rxkad_stats != NULL && pthread_setspecific(rxkad_stats_key,rxkad_stats) == 0);
124 memset(rxkad_stats,0,sizeof(rxkad_stats_t));
125 RXKAD_GLOBAL_STATS_LOCK;
126 DLL_INSERT_TAIL(rxkad_stats, rxkad_global_stats.first, rxkad_global_stats.last, next, prev);
127 RXKAD_GLOBAL_STATS_UNLOCK;
131 int rxkad_stats_agg(rxkad_stats_t * rxkad_stats) {
132 rxkad_stats_t * thr_stats;
133 assert(rxkad_stats != NULL);
134 memset(rxkad_stats, 0, sizeof(rxkad_stats_t));
135 RXKAD_GLOBAL_STATS_LOCK;
136 for (thr_stats = rxkad_global_stats.first; thr_stats != NULL; thr_stats = thr_stats->next) {
137 rxkad_stats->connections[0] += thr_stats->connections[0];
138 rxkad_stats->connections[1] += thr_stats->connections[1];
139 rxkad_stats->connections[2] += thr_stats->connections[2];
140 rxkad_stats->destroyObject += thr_stats->destroyObject;
141 rxkad_stats->destroyClient += thr_stats->destroyClient;
142 rxkad_stats->destroyUnused += thr_stats->destroyUnused;
143 rxkad_stats->destroyUnauth += thr_stats->destroyUnauth;
144 rxkad_stats->destroyConn[0] += thr_stats->destroyConn[0];
145 rxkad_stats->destroyConn[1] += thr_stats->destroyConn[1];
146 rxkad_stats->destroyConn[2] += thr_stats->destroyConn[2];
147 rxkad_stats->expired += thr_stats->expired;
148 rxkad_stats->challengesSent += thr_stats->challengesSent;
149 rxkad_stats->challenges[0] += thr_stats->challenges[0];
150 rxkad_stats->challenges[1] += thr_stats->challenges[1];
151 rxkad_stats->challenges[2] += thr_stats->challenges[2];
152 rxkad_stats->responses[0] += thr_stats->responses[0];
153 rxkad_stats->responses[1] += thr_stats->responses[1];
154 rxkad_stats->responses[2] += thr_stats->responses[2];
155 rxkad_stats->preparePackets[0] += thr_stats->preparePackets[0];
156 rxkad_stats->preparePackets[1] += thr_stats->preparePackets[1];
157 rxkad_stats->preparePackets[2] += thr_stats->preparePackets[2];
158 rxkad_stats->preparePackets[3] += thr_stats->preparePackets[3];
159 rxkad_stats->preparePackets[4] += thr_stats->preparePackets[4];
160 rxkad_stats->preparePackets[5] += thr_stats->preparePackets[5];
161 rxkad_stats->checkPackets[0] += thr_stats->checkPackets[0];
162 rxkad_stats->checkPackets[1] += thr_stats->checkPackets[1];
163 rxkad_stats->checkPackets[2] += thr_stats->checkPackets[2];
164 rxkad_stats->checkPackets[3] += thr_stats->checkPackets[3];
165 rxkad_stats->checkPackets[4] += thr_stats->checkPackets[4];
166 rxkad_stats->checkPackets[5] += thr_stats->checkPackets[5];
167 rxkad_stats->bytesEncrypted[0] += thr_stats->bytesEncrypted[0];
168 rxkad_stats->bytesEncrypted[1] += thr_stats->bytesEncrypted[1];
169 rxkad_stats->bytesDecrypted[0] += thr_stats->bytesDecrypted[0];
170 rxkad_stats->bytesDecrypted[1] += thr_stats->bytesDecrypted[1];
171 rxkad_stats->fc_encrypts[0] += thr_stats->fc_encrypts[0];
172 rxkad_stats->fc_encrypts[1] += thr_stats->fc_encrypts[1];
173 rxkad_stats->fc_key_scheds += thr_stats->fc_key_scheds;
174 rxkad_stats->des_encrypts[0] += thr_stats->des_encrypts[0];
175 rxkad_stats->des_encrypts[1] += thr_stats->des_encrypts[1];
176 rxkad_stats->des_key_scheds += thr_stats->des_key_scheds;
177 rxkad_stats->des_randoms += thr_stats->des_randoms;
178 rxkad_stats->spares[0] += thr_stats->spares[0];
179 rxkad_stats->spares[1] += thr_stats->spares[1];
180 rxkad_stats->spares[2] += thr_stats->spares[2];
181 rxkad_stats->spares[3] += thr_stats->spares[3];
182 rxkad_stats->spares[4] += thr_stats->spares[4];
183 rxkad_stats->spares[5] += thr_stats->spares[5];
184 rxkad_stats->spares[6] += thr_stats->spares[6];
185 rxkad_stats->spares[7] += thr_stats->spares[7];
186 rxkad_stats->spares[8] += thr_stats->spares[8];
187 rxkad_stats->spares[9] += thr_stats->spares[9];
189 RXKAD_GLOBAL_STATS_UNLOCK;
192 #endif /* AFS_PTHREAD_ENV */
194 /* static prototypes */
195 static afs_int32 ComputeSum(struct rx_packet *apacket,
196 fc_KeySchedule * aschedule, afs_int32 * aivec);
197 static afs_int32 FreeObject(struct rx_securityClass *aobj);
199 /* this call sets up an endpoint structure, leaving it in *network* byte
200 * order so that it can be used quickly for encryption.
203 rxkad_SetupEndpoint(struct rx_connection *aconnp,
204 struct rxkad_endpoint *aendpointp)
206 register afs_int32 i;
208 aendpointp->cuid[0] = htonl(aconnp->epoch);
209 i = aconnp->cid & RX_CIDMASK;
210 aendpointp->cuid[1] = htonl(i);
211 aendpointp->cksum = 0; /* used as cksum only in chal resp. */
212 aendpointp->securityIndex = htonl(aconnp->securityIndex);
216 /* setup xor information based on session key */
218 rxkad_DeriveXORInfo(struct rx_connection *aconnp, fc_KeySchedule * aschedule,
219 char *aivec, char *aresult)
221 struct rxkad_endpoint tendpoint;
224 rxkad_SetupEndpoint(aconnp, &tendpoint);
225 memcpy((void *)xor, aivec, 2 * sizeof(afs_int32));
226 fc_cbc_encrypt(&tendpoint, &tendpoint, sizeof(tendpoint), aschedule, xor,
229 ((char *)&tendpoint) + sizeof(tendpoint) - ENCRYPTIONBLOCKSIZE,
230 ENCRYPTIONBLOCKSIZE);
234 /* rxkad_CksumChallengeResponse - computes a checksum of the components of a
235 * challenge response packet (which must be unencrypted and in network order).
236 * The endpoint.cksum field is omitted and treated as zero. The cksum is
237 * returned in network order. */
240 rxkad_CksumChallengeResponse(struct rxkad_v2ChallengeResponse * v2r)
244 u_char *cp = (u_char *) v2r;
245 afs_uint32 savedCksum = v2r->encrypted.endpoint.cksum;
247 v2r->encrypted.endpoint.cksum = 0;
249 /* this function captured from budb/db_hash.c */
251 for (i = 0; i < sizeof(*v2r); i++)
252 cksum = (*cp++) + cksum * 0x10204081;
254 v2r->encrypted.endpoint.cksum = savedCksum;
259 rxkad_SetLevel(struct rx_connection *conn, rxkad_level level)
261 if (level == rxkad_auth) {
262 rx_SetSecurityHeaderSize(conn, 4);
263 rx_SetSecurityMaxTrailerSize(conn, 4);
264 } else if (level == rxkad_crypt) {
265 rx_SetSecurityHeaderSize(conn, 8);
266 rx_SetSecurityMaxTrailerSize(conn, 8); /* XXX was 7, but why screw with
267 * unaligned accesses? */
271 /* returns a short integer in host byte order representing a good checksum of
275 ComputeSum(struct rx_packet *apacket, fc_KeySchedule * aschedule,
279 register afs_uint32 t;
281 t = apacket->header.callNumber;
283 /* note that word [1] includes the channel # */
284 t = ((apacket->header.cid & 0x3) << 30)
285 | ((apacket->header.seq & 0x3fffffff));
287 /* XOR in the ivec from the per-endpoint encryption */
290 /* encrypts word as if it were a character string */
291 fc_ecb_encrypt(word, word, aschedule, ENCRYPT);
293 t = (t >> 16) & 0xffff;
295 t = 1; /* so that 0 means don't care */
301 FreeObject(struct rx_securityClass *aobj)
303 struct rxkad_cprivate *tcp; /* both structs start w/ type field */
305 if (aobj->refCount > 0)
306 return 0; /* still in use */
307 tcp = (struct rxkad_cprivate *)aobj->privateData;
308 rxi_Free(aobj, sizeof(struct rx_securityClass));
309 if (tcp->type & rxkad_client) {
310 rxi_Free(tcp, sizeof(struct rxkad_cprivate));
311 } else if (tcp->type & rxkad_server) {
312 rxi_Free(tcp, sizeof(struct rxkad_sprivate));
314 return RXKADINCONSISTENCY;
316 INC_RXKAD_STATS(destroyObject);
320 /* rxkad_Close - called by rx with the security class object as a parameter
321 * when a security object is to be discarded */
324 rxkad_Close(struct rx_securityClass *aobj)
328 code = FreeObject(aobj);
332 /* either: called to (re)create a new connection. */
335 rxkad_NewConnection(struct rx_securityClass *aobj,
336 struct rx_connection *aconn)
338 if (aconn->securityData)
339 return RXKADINCONSISTENCY; /* already allocated??? */
341 if (rx_IsServerConn(aconn)) {
342 int size = sizeof(struct rxkad_sconn);
343 aconn->securityData = (char *)rxi_Alloc(size);
344 memset(aconn->securityData, 0, size); /* initialize it conveniently */
345 } else { /* client */
346 struct rxkad_cprivate *tcp;
347 struct rxkad_cconn *tccp;
348 int size = sizeof(struct rxkad_cconn);
349 tccp = (struct rxkad_cconn *)rxi_Alloc(size);
350 aconn->securityData = (char *)tccp;
351 memset(aconn->securityData, 0, size); /* initialize it conveniently */
352 tcp = (struct rxkad_cprivate *)aobj->privateData;
353 if (!(tcp->type & rxkad_client))
354 return RXKADINCONSISTENCY;
355 rxkad_SetLevel(aconn, tcp->level); /* set header and trailer sizes */
356 rxkad_AllocCID(aobj, aconn); /* CHANGES cid AND epoch!!!! */
357 rxkad_DeriveXORInfo(aconn, tcp->keysched, tcp->ivec, tccp->preSeq);
358 INC_RXKAD_STATS(connections[rxkad_LevelIndex(tcp->level)]);
361 aobj->refCount++; /* attached connection */
365 /* either: called to destroy a connection. */
368 rxkad_DestroyConnection(struct rx_securityClass *aobj,
369 struct rx_connection *aconn)
371 if (rx_IsServerConn(aconn)) {
372 struct rxkad_sconn *sconn;
373 struct rxkad_serverinfo *rock;
374 sconn = (struct rxkad_sconn *)aconn->securityData;
376 aconn->securityData = 0;
377 if (sconn->authenticated)
378 INC_RXKAD_STATS(destroyConn[rxkad_LevelIndex(sconn->level)]);
380 INC_RXKAD_STATS(destroyUnauth);
383 rxi_Free(rock, sizeof(struct rxkad_serverinfo));
384 rxi_Free(sconn, sizeof(struct rxkad_sconn));
386 INC_RXKAD_STATS(destroyUnused);
388 } else { /* client */
389 struct rxkad_cconn *cconn;
390 struct rxkad_cprivate *tcp;
391 cconn = (struct rxkad_cconn *)aconn->securityData;
392 tcp = (struct rxkad_cprivate *)aobj->privateData;
393 if (!(tcp->type & rxkad_client))
394 return RXKADINCONSISTENCY;
396 aconn->securityData = 0;
397 rxi_Free(cconn, sizeof(struct rxkad_cconn));
399 INC_RXKAD_STATS(destroyClient);
401 aobj->refCount--; /* decrement connection counter */
402 if (aobj->refCount <= 0) {
404 code = FreeObject(aobj);
411 /* either: decode packet */
414 rxkad_CheckPacket(struct rx_securityClass *aobj, struct rx_call *acall,
415 struct rx_packet *apacket)
417 struct rx_connection *tconn;
419 fc_KeySchedule *schedule;
420 fc_InitializationVector *ivec;
423 u_int word; /* so we get unsigned right-shift */
428 tconn = rx_ConnectionOf(acall);
429 len = rx_GetDataSize(apacket);
430 checkCksum = 0; /* init */
431 if (rx_IsServerConn(tconn)) {
432 struct rxkad_sconn *sconn;
433 sconn = (struct rxkad_sconn *)tconn->securityData;
434 if (rx_GetPacketCksum(apacket) != 0)
435 sconn->cksumSeen = 1;
436 checkCksum = sconn->cksumSeen;
437 if (sconn && sconn->authenticated
438 && (osi_Time() < sconn->expirationTime)) {
439 level = sconn->level;
440 INC_RXKAD_STATS(checkPackets[rxkad_StatIndex(rxkad_server, level)]);
441 sconn->stats.packetsReceived++;
442 sconn->stats.bytesReceived += len;
443 schedule = (fc_KeySchedule *) sconn->keysched;
444 ivec = (fc_InitializationVector *) sconn->ivec;
446 INC_RXKAD_STATS(expired);
449 preSeq = sconn->preSeq;
450 } else { /* client connection */
451 struct rxkad_cconn *cconn;
452 struct rxkad_cprivate *tcp;
453 cconn = (struct rxkad_cconn *)tconn->securityData;
454 if (rx_GetPacketCksum(apacket) != 0)
455 cconn->cksumSeen = 1;
456 checkCksum = cconn->cksumSeen;
457 tcp = (struct rxkad_cprivate *)aobj->privateData;
458 if (!(tcp->type & rxkad_client))
459 return RXKADINCONSISTENCY;
461 INC_RXKAD_STATS(checkPackets[rxkad_StatIndex(rxkad_client, level)]);
462 cconn->stats.packetsReceived++;
463 cconn->stats.bytesReceived += len;
464 preSeq = cconn->preSeq;
465 schedule = (fc_KeySchedule *) tcp->keysched;
466 ivec = (fc_InitializationVector *) tcp->ivec;
470 code = ComputeSum(apacket, schedule, preSeq);
471 if (code != rx_GetPacketCksum(apacket))
472 return RXKADSEALEDINCON;
477 return 0; /* shouldn't happen */
479 rx_Pullup(apacket, 8); /* the following encrypts 8 bytes only */
480 fc_ecb_encrypt(rx_DataOf(apacket), rx_DataOf(apacket), schedule,
484 code = rxkad_DecryptPacket(tconn, schedule, ivec, len, apacket);
489 word = ntohl(rx_GetInt32(apacket, 0)); /* get first sealed word */
491 ((apacket->header.seq ^ apacket->header.callNumber) & 0xffff))
492 return RXKADSEALEDINCON;
493 nlen = word & 0xffff; /* get real user data length */
495 /* The sealed length should be no larger than the initial length, since the
496 * reverse (round-up) occurs in ...PreparePacket */
499 rx_SetDataSize(apacket, nlen);
503 /* either: encode packet */
506 rxkad_PreparePacket(struct rx_securityClass *aobj, struct rx_call *acall,
507 struct rx_packet *apacket)
509 struct rx_connection *tconn;
511 fc_KeySchedule *schedule;
512 fc_InitializationVector *ivec;
519 tconn = rx_ConnectionOf(acall);
520 len = rx_GetDataSize(apacket);
521 if (rx_IsServerConn(tconn)) {
522 struct rxkad_sconn *sconn;
523 sconn = (struct rxkad_sconn *)tconn->securityData;
524 if (sconn && sconn->authenticated
525 && (osi_Time() < sconn->expirationTime)) {
526 level = sconn->level;
527 INC_RXKAD_STATS(preparePackets[rxkad_StatIndex(rxkad_server, level)]);
528 sconn->stats.packetsSent++;
529 sconn->stats.bytesSent += len;
530 schedule = (fc_KeySchedule *) sconn->keysched;
531 ivec = (fc_InitializationVector *) sconn->ivec;
533 INC_RXKAD_STATS(expired); /* this is a pretty unlikely path... */
536 preSeq = sconn->preSeq;
537 } else { /* client connection */
538 struct rxkad_cconn *cconn;
539 struct rxkad_cprivate *tcp;
540 cconn = (struct rxkad_cconn *)tconn->securityData;
541 tcp = (struct rxkad_cprivate *)aobj->privateData;
542 if (!(tcp->type & rxkad_client))
543 return RXKADINCONSISTENCY;
545 INC_RXKAD_STATS(preparePackets[rxkad_StatIndex(rxkad_client, level)]);
546 cconn->stats.packetsSent++;
547 cconn->stats.bytesSent += len;
548 preSeq = cconn->preSeq;
549 schedule = (fc_KeySchedule *) tcp->keysched;
550 ivec = (fc_InitializationVector *) tcp->ivec;
553 /* compute upward compatible checksum */
554 rx_SetPacketCksum(apacket, ComputeSum(apacket, schedule, preSeq));
555 if (level == rxkad_clear)
558 len = rx_GetDataSize(apacket);
559 word = (((apacket->header.seq ^ apacket->header.callNumber)
560 & 0xffff) << 16) | (len & 0xffff);
561 rx_PutInt32(apacket, 0, htonl(word));
565 return 0; /* shouldn't happen */
568 afs_max(ENCRYPTIONBLOCKSIZE,
569 len + rx_GetSecurityHeaderSize(tconn));
570 if (nlen > (len + rx_GetSecurityHeaderSize(tconn))) {
571 rxi_RoundUpPacket(apacket,
572 nlen - (len + rx_GetSecurityHeaderSize(tconn)));
574 rx_Pullup(apacket, 8); /* the following encrypts 8 bytes only */
575 fc_ecb_encrypt(rx_DataOf(apacket), rx_DataOf(apacket), schedule,
579 nlen = round_up_to_ebs(len + rx_GetSecurityHeaderSize(tconn));
580 if (nlen > (len + rx_GetSecurityHeaderSize(tconn))) {
581 rxi_RoundUpPacket(apacket,
582 nlen - (len + rx_GetSecurityHeaderSize(tconn)));
584 code = rxkad_EncryptPacket(tconn, schedule, ivec, nlen, apacket);
589 rx_SetDataSize(apacket, nlen);
593 /* either: return connection stats */
596 rxkad_GetStats(struct rx_securityClass *aobj, struct rx_connection *aconn,
597 struct rx_securityObjectStats *astats)
600 astats->level = ((struct rxkad_cprivate *)aobj->privateData)->level;
601 if (!aconn->securityData) {
605 if (rx_IsServerConn(aconn)) {
606 struct rxkad_sconn *sconn;
607 sconn = (struct rxkad_sconn *)aconn->securityData;
608 astats->level = sconn->level;
609 if (sconn->authenticated)
611 if (sconn->cksumSeen)
613 astats->expires = sconn->expirationTime;
614 astats->bytesReceived = sconn->stats.bytesReceived;
615 astats->packetsReceived = sconn->stats.packetsReceived;
616 astats->bytesSent = sconn->stats.bytesSent;
617 astats->packetsSent = sconn->stats.packetsSent;
618 } else { /* client connection */
619 struct rxkad_cconn *cconn;
620 cconn = (struct rxkad_cconn *)aconn->securityData;
621 if (cconn->cksumSeen)
623 astats->bytesReceived = cconn->stats.bytesReceived;
624 astats->packetsReceived = cconn->stats.packetsReceived;
625 astats->bytesSent = cconn->stats.bytesSent;
626 astats->packetsSent = cconn->stats.packetsSent;
632 rxkad_StringToLevel(char *name)
634 if (strcmp(name, "clear") == 0)
636 if (strcmp(name, "auth") == 0)
638 if (strcmp(name, "crypt") == 0)
644 rxkad_LevelToString(rxkad_level level)
646 if (level == rxkad_clear)
648 if (level == rxkad_auth)
650 if (level == rxkad_crypt)