8e7204318f0a9ce08d26d2e437c6448050c7da8a
[openafs.git] / src / rxkad / rxkad.p.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 /* The Kerberos Authenticated DES security object. */
11
12
13 #ifndef OPENAFS_RXKAD_RXKAD_H
14 #define OPENAFS_RXKAD_RXKAD_H
15
16                 /* no ticket good for longer than 30 days */
17 #define MAXKTCTICKETLIFETIME (30*24*3600)
18 #define MINKTCTICKETLEN       32
19 #define MAXKTCTICKETLEN       12000 /* was 344 */
20 #define MAXKTCNAMELEN         64        /* name & inst should be 256 */
21 #define MAXKTCREALMLEN        64        /* should be 256 */
22 #define KTC_TIME_UNCERTAINTY (15*60)    /* max skew bet. machines' clocks */
23
24 #define MAXRANDOMNAMELEN 16     /* length of random generated 
25                              * usernames used by afslog for high 
26                              * security must be < MAXKTCNAMELEN && < MAXSMBNAMELEN */
27 #define MAXSMBNAMELEN    256 /* max length of an SMB name */
28
29 #define LOGON_OPTION_INTEGRATED 1
30 #define LOGON_OPTION_HIGHSECURITY 2
31
32 /*
33  * Define ticket types. For Kerberos V4 tickets, this is overloaded as
34  * the server key version number, so class numbers 0 through 255 are reserved
35  * for V4 tickets. For Kerberos V5, tickets have an in-the-clear portion
36  * containing the server key version, so we only use a single type number to
37  * identify those tickets. The ticket type is carried in the kvno field
38  * passed to/from ktc_[SG]etToken.
39  */
40 #define RXKAD_TKT_TYPE_KERBEROS_V5              256
41 #define RXKAD_TKT_TYPE_KERBEROS_V5_ENCPART_ONLY 213
42
43 #define MAXKRB5TICKETLEN                   MAXKTCTICKETLEN
44
45 /*
46  * The AFS/DFS translator may also make use of additional ticket types in
47  * the range 257 through 511. DO NOT USE THESE FOR ANY OTHER PURPOSE.
48  */
49 #define RXKAD_TKT_TYPE_ADAPT_RESERVED_MIN       257
50 #define RXKAD_TKT_TYPE_ADAPT_RESERVED_MAX       511
51
52 struct ktc_encryptionKey {
53     char data[8];
54 };
55
56 struct ktc_principal {
57     char name[MAXKTCNAMELEN];
58     char instance[MAXKTCNAMELEN];
59     char cell[MAXKTCREALMLEN];
60 #ifdef AFS_NT40_ENV
61     char smbname[MAXSMBNAMELEN];
62 #endif
63 };
64
65 #ifndef NEVERDATE
66 #define NEVERDATE 0xffffffff
67 #endif
68
69 /* this function round a length to the correct encryption block size */
70 #define round_up_to_ebs(v) (((v) + 7) & (~7))
71
72 typedef char rxkad_type;
73 #define rxkad_client 1          /* bits definitions */
74 #define rxkad_server 2
75
76 typedef char rxkad_level;
77 #define rxkad_clear 0           /* send packets in the clear */
78 #define rxkad_auth 1            /* send encrypted sequence numbers */
79 #define rxkad_crypt 2           /* encrypt packet data */
80
81 /* many stats are kept per type and per level.  These are encoded into an index
82  * from 0 to 5 by the StatIndex macro. */
83
84 #define rxkad_StatIndex(type,level) \
85     (((((type) == 1) || ((type) == 2)) && ((level) >= 0) && ((level) <= 2)) \
86      ? (((level)<<1)+(type)-1) : 0)
87 #define rxkad_LevelIndex(level) \
88     ((((level) >= 0) && ((level) <= 2)) ? (level) : 0)
89 #define rxkad_TypeIndex(type) \
90     ((((type) == 1) || ((type) == 2)) ? (type) : 0)
91
92 struct rxkad_stats {
93     afs_uint32 connections[3];  /* client side only */
94     afs_uint32 destroyObject;   /* client security objects */
95     afs_uint32 destroyClient;   /* client connections */
96     afs_uint32 destroyUnused;   /* unused server conn */
97     afs_uint32 destroyUnauth;   /* unauthenticated server conn */
98     afs_uint32 destroyConn[3];  /* server conn per level */
99     afs_uint32 expired;         /* server packets rejected */
100     afs_uint32 challengesSent;  /* server challenges sent */
101     afs_uint32 challenges[3];   /* challenges seen by client */
102     afs_uint32 responses[3];    /* responses seen by server */
103     afs_uint32 preparePackets[6];
104     afs_uint32 checkPackets[6];
105     afs_uint32 bytesEncrypted[2];       /* index just by type */
106     afs_uint32 bytesDecrypted[2];
107     afs_uint32 fc_encrypts[2];  /* DECRYPT==0, ENCRYPT==1 */
108     afs_uint32 fc_key_scheds;   /* key schedule creations */
109     afs_uint32 des_encrypts[2]; /* DECRYPT==0, ENCRYPT==1 */
110     afs_uint32 des_key_scheds;  /* key schedule creations */
111     afs_uint32 des_randoms;     /* random blocks generated */
112     long spares[10];
113 };
114
115 #if defined(AFS_NT40_ENV) && defined(AFS_PTHREAD_ENV)
116 #ifndef RXKAD_STATS_DECLSPEC
117 #define RXKAD_STATS_DECLSPEC __declspec(dllimport) extern
118 #endif
119 #else
120 #define RXKAD_STATS_DECLSPEC extern
121 #endif
122 RXKAD_STATS_DECLSPEC struct rxkad_stats rxkad_stats;
123 #ifdef AFS_PTHREAD_ENV
124 #include <pthread.h>
125 #include <assert.h>
126 extern pthread_mutex_t rxkad_stats_mutex;
127 #define LOCK_RXKAD_STATS assert(pthread_mutex_lock(&rxkad_stats_mutex)==0);
128 #define UNLOCK_RXKAD_STATS assert(pthread_mutex_unlock(&rxkad_stats_mutex)==0);
129 #else
130 #define LOCK_RXKAD_STATS
131 #define UNLOCK_RXKAD_STATS
132 #endif
133
134
135 /* gak! using up spares already! */
136 #define rxkad_stats_clientObjects (rxkad_stats.spares[0])
137 #define rxkad_stats_serverObjects (rxkad_stats.spares[1])
138
139 extern int rxkad_EpochWasSet;   /* TRUE => we called rx_SetEpoch */
140
141 #include "rxkad_prototypes.h"
142
143 #endif /* OPENAFS_RXKAD_RXKAD_H */