2 * linux/include/linux/sunrpc/gss_krb5_types.h
4 * Adapted from MIT Kerberos 5-1.2.1 lib/include/krb5.h,
5 * lib/gssapi/krb5/gssapiP_krb5.h, and others
7 * Copyright (c) 2000-2008 The Regents of the University of Michigan.
10 * Andy Adamson <andros@umich.edu>
11 * Bruce Fields <bfields@umich.edu>
15 * Copyright 1995 by the Massachusetts Institute of Technology.
16 * All Rights Reserved.
18 * Export of this software from the United States of America may
19 * require a specific license from the United States Government.
20 * It is the responsibility of any person or organization contemplating
21 * export to obtain such a license before exporting.
23 * WITHIN THAT CONSTRAINT, permission to use, copy, modify, and
24 * distribute this software and its documentation for any purpose and
25 * without fee is hereby granted, provided that the above copyright
26 * notice appear in all copies and that both that copyright notice and
27 * this permission notice appear in supporting documentation, and that
28 * the name of M.I.T. not be used in advertising or publicity pertaining
29 * to distribution of the software without specific, written prior
30 * permission. Furthermore if you modify this software you must label
31 * your software as modified software and not distribute it in such a
32 * fashion that it might be confused with the original M.I.T. software.
33 * M.I.T. makes no representations about the suitability of
34 * this software for any purpose. It is provided "as is" without express
35 * or implied warranty.
39 #include <linux/crypto.h>
40 #include <linux/sunrpc/auth_gss.h>
41 #include <linux/sunrpc/gss_err.h>
42 #include <linux/sunrpc/gss_asn1.h>
44 /* Length of constant used in key derivation */
45 #define GSS_KRB5_K5CLENGTH (5)
47 /* Maximum key length (in bytes) for the supported crypto algorithms*/
48 #define GSS_KRB5_MAX_KEYLEN (32)
50 /* Maximum checksum function output for the supported crypto algorithms */
51 #define GSS_KRB5_MAX_CKSUM_LEN (20)
53 /* Maximum blocksize for the supported crypto algorithms */
54 #define GSS_KRB5_MAX_BLOCKSIZE (16)
58 struct gss_krb5_enctype {
59 const u32 etype; /* encryption (key) type */
60 const u32 ctype; /* checksum type */
61 const char *name; /* "friendly" name */
62 const char *encrypt_name; /* crypto encrypt name */
63 const char *cksum_name; /* crypto checksum name */
64 const u16 signalg; /* signing algorithm */
65 const u16 sealalg; /* sealing algorithm */
66 const u32 blocksize; /* encryption blocksize */
67 const u32 cksumlength; /* checksum length */
68 const u32 keyed_cksum; /* is it a keyed cksum? */
69 const u32 keybytes; /* raw key len, in bytes */
70 const u32 keylength; /* final key len, in bytes */
71 u32 (*encrypt) (struct crypto_blkcipher *tfm,
72 void *iv, void *in, void *out,
73 int length); /* encryption function */
74 u32 (*decrypt) (struct crypto_blkcipher *tfm,
75 void *iv, void *in, void *out,
76 int length); /* decryption function */
77 u32 (*mk_key) (const struct gss_krb5_enctype *gk5e,
78 struct xdr_netobj *in,
79 struct xdr_netobj *out); /* complete key generation */
80 u32 (*encrypt_v2) (struct krb5_ctx *kctx, u32 offset,
81 struct xdr_buf *buf, int ec,
82 struct page **pages); /* v2 encryption function */
83 u32 (*decrypt_v2) (struct krb5_ctx *kctx, u32 offset,
84 struct xdr_buf *buf, u32 *headskip,
85 u32 *tailskip); /* v2 decryption function */
88 /* krb5_ctx flags definitions */
89 #define KRB5_CTX_FLAG_INITIATOR 0x00000001
90 #define KRB5_CTX_FLAG_CFX 0x00000002
91 #define KRB5_CTX_FLAG_ACCEPTOR_SUBKEY 0x00000004
94 int initiate; /* 1 = initiating, 0 = accepting */
97 const struct gss_krb5_enctype *gk5e; /* enctype-specific info */
98 struct crypto_blkcipher *enc;
99 struct crypto_blkcipher *seq;
100 struct crypto_blkcipher *acceptor_enc;
101 struct crypto_blkcipher *initiator_enc;
102 u8 cksum[GSS_KRB5_MAX_KEYLEN];
106 struct xdr_netobj mech_used;
107 u8 initiator_sign[GSS_KRB5_MAX_KEYLEN];
108 u8 acceptor_sign[GSS_KRB5_MAX_KEYLEN];
109 u8 initiator_seal[GSS_KRB5_MAX_KEYLEN];
110 u8 acceptor_seal[GSS_KRB5_MAX_KEYLEN];
111 u8 initiator_integ[GSS_KRB5_MAX_KEYLEN];
112 u8 acceptor_integ[GSS_KRB5_MAX_KEYLEN];
115 extern spinlock_t krb5_seq_lock;
117 /* The length of the Kerberos GSS token header */
118 #define GSS_KRB5_TOK_HDR_LEN (16)
120 #define KG_TOK_MIC_MSG 0x0101
121 #define KG_TOK_WRAP_MSG 0x0201
123 #define KG2_TOK_INITIAL 0x0101
124 #define KG2_TOK_RESPONSE 0x0202
125 #define KG2_TOK_MIC 0x0404
126 #define KG2_TOK_WRAP 0x0504
128 #define KG2_TOKEN_FLAG_SENTBYACCEPTOR 0x01
129 #define KG2_TOKEN_FLAG_SEALED 0x02
130 #define KG2_TOKEN_FLAG_ACCEPTORSUBKEY 0x04
132 #define KG2_RESP_FLAG_ERROR 0x0001
133 #define KG2_RESP_FLAG_DELEG_OK 0x0002
136 SGN_ALG_DES_MAC_MD5 = 0x0000,
137 SGN_ALG_MD2_5 = 0x0001,
138 SGN_ALG_DES_MAC = 0x0002,
139 SGN_ALG_3 = 0x0003, /* not published */
140 SGN_ALG_HMAC_MD5 = 0x0011, /* microsoft w2k; no support */
141 SGN_ALG_HMAC_SHA1_DES3_KD = 0x0004
144 SEAL_ALG_NONE = 0xffff,
145 SEAL_ALG_DES = 0x0000,
146 SEAL_ALG_1 = 0x0001, /* not published */
147 SEAL_ALG_MICROSOFT_RC4 = 0x0010,/* microsoft w2k; no support */
148 SEAL_ALG_DES3KD = 0x0002
151 #define CKSUMTYPE_CRC32 0x0001
152 #define CKSUMTYPE_RSA_MD4 0x0002
153 #define CKSUMTYPE_RSA_MD4_DES 0x0003
154 #define CKSUMTYPE_DESCBC 0x0004
155 #define CKSUMTYPE_RSA_MD5 0x0007
156 #define CKSUMTYPE_RSA_MD5_DES 0x0008
157 #define CKSUMTYPE_NIST_SHA 0x0009
158 #define CKSUMTYPE_HMAC_SHA1_DES3 0x000c
159 #define CKSUMTYPE_HMAC_SHA1_96_AES128 0x000f
160 #define CKSUMTYPE_HMAC_SHA1_96_AES256 0x0010
161 #define CKSUMTYPE_HMAC_MD5_ARCFOUR -138 /* Microsoft md5 hmac cksumtype */
163 /* from gssapi_err_krb5.h */
164 #define KG_CCACHE_NOMATCH (39756032L)
165 #define KG_KEYTAB_NOMATCH (39756033L)
166 #define KG_TGT_MISSING (39756034L)
167 #define KG_NO_SUBKEY (39756035L)
168 #define KG_CONTEXT_ESTABLISHED (39756036L)
169 #define KG_BAD_SIGN_TYPE (39756037L)
170 #define KG_BAD_LENGTH (39756038L)
171 #define KG_CTX_INCOMPLETE (39756039L)
172 #define KG_CONTEXT (39756040L)
173 #define KG_CRED (39756041L)
174 #define KG_ENC_DESC (39756042L)
175 #define KG_BAD_SEQ (39756043L)
176 #define KG_EMPTY_CCACHE (39756044L)
177 #define KG_NO_CTYPES (39756045L)
179 /* per Kerberos v5 protocol spec crypto types from the wire.
180 * these get mapped to linux kernel crypto routines.
182 #define ENCTYPE_NULL 0x0000
183 #define ENCTYPE_DES_CBC_CRC 0x0001 /* DES cbc mode with CRC-32 */
184 #define ENCTYPE_DES_CBC_MD4 0x0002 /* DES cbc mode with RSA-MD4 */
185 #define ENCTYPE_DES_CBC_MD5 0x0003 /* DES cbc mode with RSA-MD5 */
186 #define ENCTYPE_DES_CBC_RAW 0x0004 /* DES cbc mode raw */
187 /* XXX deprecated? */
188 #define ENCTYPE_DES3_CBC_SHA 0x0005 /* DES-3 cbc mode with NIST-SHA */
189 #define ENCTYPE_DES3_CBC_RAW 0x0006 /* DES-3 cbc mode raw */
190 #define ENCTYPE_DES_HMAC_SHA1 0x0008
191 #define ENCTYPE_DES3_CBC_SHA1 0x0010
192 #define ENCTYPE_AES128_CTS_HMAC_SHA1_96 0x0011
193 #define ENCTYPE_AES256_CTS_HMAC_SHA1_96 0x0012
194 #define ENCTYPE_ARCFOUR_HMAC 0x0017
195 #define ENCTYPE_ARCFOUR_HMAC_EXP 0x0018
196 #define ENCTYPE_UNKNOWN 0x01ff
199 * Constants used for key derivation
202 #define KG_USAGE_SEAL (22)
203 #define KG_USAGE_SIGN (23)
204 #define KG_USAGE_SEQ (24)
207 #define KEY_USAGE_SEED_CHECKSUM (0x99)
208 #define KEY_USAGE_SEED_ENCRYPTION (0xAA)
209 #define KEY_USAGE_SEED_INTEGRITY (0x55)
212 #define KG_USAGE_ACCEPTOR_SEAL (22)
213 #define KG_USAGE_ACCEPTOR_SIGN (23)
214 #define KG_USAGE_INITIATOR_SEAL (24)
215 #define KG_USAGE_INITIATOR_SIGN (25)
218 * This compile-time check verifies that we will not exceed the
219 * slack space allotted by the client and server auth_gss code
220 * before they call gss_wrap().
222 #define GSS_KRB5_MAX_SLACK_NEEDED \
223 (GSS_KRB5_TOK_HDR_LEN /* gss token header */ \
224 + GSS_KRB5_MAX_CKSUM_LEN /* gss token checksum */ \
225 + GSS_KRB5_MAX_BLOCKSIZE /* confounder */ \
226 + GSS_KRB5_MAX_BLOCKSIZE /* possible padding */ \
227 + GSS_KRB5_TOK_HDR_LEN /* encrypted hdr in v2 token */\
228 + GSS_KRB5_MAX_CKSUM_LEN /* encryption hmac */ \
229 + 4 + 4 /* RPC verifier */ \
230 + GSS_KRB5_TOK_HDR_LEN \
231 + GSS_KRB5_MAX_CKSUM_LEN)
234 make_checksum(struct krb5_ctx *kctx, char *header, int hdrlen,
235 struct xdr_buf *body, int body_offset, u8 *cksumkey,
236 struct xdr_netobj *cksumout);
239 make_checksum_v2(struct krb5_ctx *, char *header, int hdrlen,
240 struct xdr_buf *body, int body_offset, u8 *key,
241 struct xdr_netobj *cksum);
243 u32 gss_get_mic_kerberos(struct gss_ctx *, struct xdr_buf *,
244 struct xdr_netobj *);
246 u32 gss_verify_mic_kerberos(struct gss_ctx *, struct xdr_buf *,
247 struct xdr_netobj *);
250 gss_wrap_kerberos(struct gss_ctx *ctx_id, int offset,
251 struct xdr_buf *outbuf, struct page **pages);
254 gss_unwrap_kerberos(struct gss_ctx *ctx_id, int offset,
255 struct xdr_buf *buf);
259 krb5_encrypt(struct crypto_blkcipher *key,
260 void *iv, void *in, void *out, int length);
263 krb5_decrypt(struct crypto_blkcipher *key,
264 void *iv, void *in, void *out, int length);
267 gss_encrypt_xdr_buf(struct crypto_blkcipher *tfm, struct xdr_buf *outbuf,
268 int offset, struct page **pages);
271 gss_decrypt_xdr_buf(struct crypto_blkcipher *tfm, struct xdr_buf *inbuf,
275 krb5_make_seq_num(struct crypto_blkcipher *key,
277 u32 seqnum, unsigned char *cksum, unsigned char *buf);
280 krb5_get_seq_num(struct crypto_blkcipher *key,
281 unsigned char *cksum,
282 unsigned char *buf, int *direction, u32 *seqnum);
285 xdr_extend_head(struct xdr_buf *buf, unsigned int base, unsigned int shiftlen);
288 krb5_derive_key(const struct gss_krb5_enctype *gk5e,
289 const struct xdr_netobj *inkey,
290 struct xdr_netobj *outkey,
291 const struct xdr_netobj *in_constant);
294 gss_krb5_des3_make_key(const struct gss_krb5_enctype *gk5e,
295 struct xdr_netobj *randombits,
296 struct xdr_netobj *key);