rxkad-prototypes-20081129
[openafs.git] / src / rxkad / private_data.h
1 /*
2  * Copyright 2000, International Business Machines Corporation and others.
3  * All Rights Reserved.
4  * 
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
8  */
9
10 /* Declarations of data structures associated with rxkad security objects. */
11
12 #ifndef RXKAD_PRIVATE_DATA_H
13 #define RXKAD_PRIVATE_DATA_H
14
15 #include "rxkad.h"
16
17
18 #include "fcrypt.h"
19
20 struct connStats {
21     afs_uint32 bytesReceived, bytesSent, packetsReceived, packetsSent;
22 };
23
24 /* Private data structure representing an RX server end point for rxkad.
25  * This structure is encrypted in network byte order and transmitted as
26  * part of a challenge response.  It is also used as part of the per-packet
27  * checksum sent on every packet, to ensure that the per-packet checksum
28  * is not used in the context of another end point.
29  *
30  * THIS STRUCTURE MUST BE A MULTIPLE OF 8 BYTES LONG SINCE IT IS
31  * ENCRYPTED IN PLACE!
32  */
33 struct rxkad_endpoint {
34     afs_int32 cuid[2];          /* being used for connection routing */
35     afs_uint32 cksum;           /* cksum of challenge response */
36     afs_int32 securityIndex;    /* security index */
37 };
38
39 /* structure used for generating connection IDs; must be encrypted in network
40  * byte order.  Also must be a multiple of 8 bytes for encryption to work
41  * properly.
42  */
43 struct rxkad_cidgen {
44     struct clock time;          /* time now */
45     afs_int32 random1;          /* some implementation-specific random info */
46     afs_int32 random2;          /* more random info */
47     afs_int32 counter;          /* a counter */
48     afs_int32 ipAddr;           /* or an approximation to it */
49 };
50
51 #define PDATA_SIZE(l) (sizeof(struct rxkad_cprivate) - MAXKTCTICKETLEN + (l))
52
53 /* private data in client-side security object */
54 /* type and level offsets should match sprivate */
55 struct rxkad_cprivate {
56     rxkad_type type;            /* always client */
57     rxkad_level level;          /* minimum security level of client */
58     afs_int32 kvno;             /* key version of ticket */
59     afs_int32 ticketLen;        /* length of ticket */
60     fc_KeySchedule keysched;    /* the session key */
61     fc_InitializationVector ivec;       /* initialization vector for cbc */
62     char ticket[MAXKTCTICKETLEN];       /* the ticket for the server */
63 };
64
65 /* Per connection client-side info */
66 struct rxkad_cconn {
67     fc_InitializationVector preSeq;     /* used in computing checksum */
68     struct connStats stats;
69     char cksumSeen;             /* rx: header.spare is a checksum */
70 };
71
72 /* private data in server-side security object */
73 /* type and level offsets should match cprivate */
74 struct rxkad_sprivate {
75     rxkad_type type;            /* always server */
76     rxkad_level level;          /* minimum security level of server */
77     void *get_key_rock;         /* rock for get_key function */
78     int (*get_key) (void *, int,
79                     struct ktc_encryptionKey *);
80                                 /* func. of kvno and server key ptr */
81     int (*user_ok) (char *, char *,
82                     char *, afs_int32);
83                                 /* func called with new client name */
84     afs_uint32 flags;           /* configuration flags */
85 };
86
87 /* private data in server-side connection */
88 struct rxkad_sconn {
89     rxkad_level level;          /* security level of connection */
90     char tried;                 /* did we ever try to auth this conn */
91     char authenticated;         /* connection is good */
92     char cksumSeen;             /* rx: header.spare is a checksum */
93     afs_uint32 expirationTime;  /* when the ticket expires */
94     afs_int32 challengeID;      /* unique challenge */
95     struct connStats stats;     /* per connection stats */
96     fc_KeySchedule keysched;    /* session key */
97     fc_InitializationVector ivec;       /* initialization vector for cbc */
98     fc_InitializationVector preSeq;     /* used in computing checksum */
99     struct rxkad_serverinfo *rock;      /* info about client if saved */
100 };
101
102 struct rxkad_serverinfo {
103     int kvno;
104     struct ktc_principal client;
105 };
106
107 #define RXKAD_CHALLENGE_PROTOCOL_VERSION 2
108
109 /* An old style (any version predating 2) challenge packet */
110 struct rxkad_oldChallenge {
111     afs_int32 challengeID;
112     afs_int32 level;            /* minimum security level */
113 };
114
115 /* A version 2 challenge */
116 struct rxkad_v2Challenge {
117     afs_int32 version;
118     afs_int32 challengeID;
119     afs_int32 level;
120     afs_int32 spare;
121 };
122
123 /* An old challenge response packet */
124 struct rxkad_oldChallengeResponse {
125     struct {                    /* encrypted with session key */
126         afs_int32 incChallengeID;
127         afs_int32 level;
128     } encrypted;
129     afs_int32 kvno;
130     afs_int32 ticketLen;
131 };
132 /*  <ticketLen> bytes of ticket follow here */
133
134 /* A version 2 challenge response also includes connection routing (Rx server
135  * end point) and client call number state as well as version and spare fields.
136  * The encrypted part probably doesn't need to start on an 8 byte boundary, but
137  * just in case we put in a spare. */
138 struct rxkad_v2ChallengeResponse {
139     afs_int32 version;
140     afs_int32 spare;
141     struct {                    /* encrypted with session key */
142         struct rxkad_endpoint endpoint; /* for connection routing */
143         afs_int32 callNumbers[RX_MAXCALLS];     /* client call # state */
144         afs_int32 incChallengeID;
145         afs_int32 level;
146     } encrypted;
147     afs_int32 kvno;
148     afs_int32 ticketLen;
149 };
150 /*  <ticketLen> bytes of ticket follow here */
151 #if RX_MAXCALLS != 4
152 The above structure requires
153 that(RX_MAXCALLS == 4).
154 #endif
155 #endif /* RXKAD_PRIVATE_DATA_H */