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