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)
56 struct gss_krb5_enctype {
57 const u32 etype; /* encryption (key) type */
58 const u32 ctype; /* checksum type */
59 const char *name; /* "friendly" name */
60 const char *encrypt_name; /* crypto encrypt name */
61 const char *cksum_name; /* crypto checksum name */
62 const u16 signalg; /* signing algorithm */
63 const u16 sealalg; /* sealing algorithm */
64 const u32 blocksize; /* encryption blocksize */
65 const u32 cksumlength; /* checksum length */
66 const u32 keyed_cksum; /* is it a keyed cksum? */
67 const u32 keybytes; /* raw key len, in bytes */
68 const u32 keylength; /* final key len, in bytes */
69 u32 (*encrypt) (struct crypto_blkcipher *tfm,
70 void *iv, void *in, void *out,
71 int length); /* encryption function */
72 u32 (*decrypt) (struct crypto_blkcipher *tfm,
73 void *iv, void *in, void *out,
74 int length); /* decryption function */
75 u32 (*mk_key) (const struct gss_krb5_enctype *gk5e,
76 struct xdr_netobj *in,
77 struct xdr_netobj *out); /* complete key generation */
80 /* krb5_ctx flags definitions */
81 #define KRB5_CTX_FLAG_INITIATOR 0x00000001
82 #define KRB5_CTX_FLAG_CFX 0x00000002
83 #define KRB5_CTX_FLAG_ACCEPTOR_SUBKEY 0x00000004
86 int initiate; /* 1 = initiating, 0 = accepting */
89 const struct gss_krb5_enctype *gk5e; /* enctype-specific info */
90 struct crypto_blkcipher *enc;
91 struct crypto_blkcipher *seq;
92 struct crypto_blkcipher *acceptor_enc;
93 struct crypto_blkcipher *initiator_enc;
94 u8 cksum[GSS_KRB5_MAX_KEYLEN];
98 struct xdr_netobj mech_used;
99 u8 initiator_sign[GSS_KRB5_MAX_KEYLEN];
100 u8 acceptor_sign[GSS_KRB5_MAX_KEYLEN];
101 u8 initiator_seal[GSS_KRB5_MAX_KEYLEN];
102 u8 acceptor_seal[GSS_KRB5_MAX_KEYLEN];
103 u8 initiator_integ[GSS_KRB5_MAX_KEYLEN];
104 u8 acceptor_integ[GSS_KRB5_MAX_KEYLEN];
107 extern spinlock_t krb5_seq_lock;
109 /* The length of the Kerberos GSS token header */
110 #define GSS_KRB5_TOK_HDR_LEN (16)
112 #define KG_TOK_MIC_MSG 0x0101
113 #define KG_TOK_WRAP_MSG 0x0201
116 SGN_ALG_DES_MAC_MD5 = 0x0000,
117 SGN_ALG_MD2_5 = 0x0001,
118 SGN_ALG_DES_MAC = 0x0002,
119 SGN_ALG_3 = 0x0003, /* not published */
120 SGN_ALG_HMAC_MD5 = 0x0011, /* microsoft w2k; no support */
121 SGN_ALG_HMAC_SHA1_DES3_KD = 0x0004
124 SEAL_ALG_NONE = 0xffff,
125 SEAL_ALG_DES = 0x0000,
126 SEAL_ALG_1 = 0x0001, /* not published */
127 SEAL_ALG_MICROSOFT_RC4 = 0x0010,/* microsoft w2k; no support */
128 SEAL_ALG_DES3KD = 0x0002
131 #define CKSUMTYPE_CRC32 0x0001
132 #define CKSUMTYPE_RSA_MD4 0x0002
133 #define CKSUMTYPE_RSA_MD4_DES 0x0003
134 #define CKSUMTYPE_DESCBC 0x0004
135 #define CKSUMTYPE_RSA_MD5 0x0007
136 #define CKSUMTYPE_RSA_MD5_DES 0x0008
137 #define CKSUMTYPE_NIST_SHA 0x0009
138 #define CKSUMTYPE_HMAC_SHA1_DES3 0x000c
140 /* from gssapi_err_krb5.h */
141 #define KG_CCACHE_NOMATCH (39756032L)
142 #define KG_KEYTAB_NOMATCH (39756033L)
143 #define KG_TGT_MISSING (39756034L)
144 #define KG_NO_SUBKEY (39756035L)
145 #define KG_CONTEXT_ESTABLISHED (39756036L)
146 #define KG_BAD_SIGN_TYPE (39756037L)
147 #define KG_BAD_LENGTH (39756038L)
148 #define KG_CTX_INCOMPLETE (39756039L)
149 #define KG_CONTEXT (39756040L)
150 #define KG_CRED (39756041L)
151 #define KG_ENC_DESC (39756042L)
152 #define KG_BAD_SEQ (39756043L)
153 #define KG_EMPTY_CCACHE (39756044L)
154 #define KG_NO_CTYPES (39756045L)
156 /* per Kerberos v5 protocol spec crypto types from the wire.
157 * these get mapped to linux kernel crypto routines.
159 #define ENCTYPE_NULL 0x0000
160 #define ENCTYPE_DES_CBC_CRC 0x0001 /* DES cbc mode with CRC-32 */
161 #define ENCTYPE_DES_CBC_MD4 0x0002 /* DES cbc mode with RSA-MD4 */
162 #define ENCTYPE_DES_CBC_MD5 0x0003 /* DES cbc mode with RSA-MD5 */
163 #define ENCTYPE_DES_CBC_RAW 0x0004 /* DES cbc mode raw */
164 /* XXX deprecated? */
165 #define ENCTYPE_DES3_CBC_SHA 0x0005 /* DES-3 cbc mode with NIST-SHA */
166 #define ENCTYPE_DES3_CBC_RAW 0x0006 /* DES-3 cbc mode raw */
167 #define ENCTYPE_DES_HMAC_SHA1 0x0008
168 #define ENCTYPE_DES3_CBC_SHA1 0x0010
169 #define ENCTYPE_AES128_CTS_HMAC_SHA1_96 0x0011
170 #define ENCTYPE_AES256_CTS_HMAC_SHA1_96 0x0012
171 #define ENCTYPE_ARCFOUR_HMAC 0x0017
172 #define ENCTYPE_ARCFOUR_HMAC_EXP 0x0018
173 #define ENCTYPE_UNKNOWN 0x01ff
176 * Constants used for key derivation
179 #define KG_USAGE_SEAL (22)
180 #define KG_USAGE_SIGN (23)
181 #define KG_USAGE_SEQ (24)
184 #define KEY_USAGE_SEED_CHECKSUM (0x99)
185 #define KEY_USAGE_SEED_ENCRYPTION (0xAA)
186 #define KEY_USAGE_SEED_INTEGRITY (0x55)
189 #define KG_USAGE_ACCEPTOR_SEAL (22)
190 #define KG_USAGE_ACCEPTOR_SIGN (23)
191 #define KG_USAGE_INITIATOR_SEAL (24)
192 #define KG_USAGE_INITIATOR_SIGN (25)
195 * This compile-time check verifies that we will not exceed the
196 * slack space allotted by the client and server auth_gss code
197 * before they call gss_wrap().
199 #define GSS_KRB5_MAX_SLACK_NEEDED \
200 (GSS_KRB5_TOK_HDR_LEN /* gss token header */ \
201 + GSS_KRB5_MAX_CKSUM_LEN /* gss token checksum */ \
202 + GSS_KRB5_MAX_BLOCKSIZE /* confounder */ \
203 + GSS_KRB5_MAX_BLOCKSIZE /* possible padding */ \
204 + GSS_KRB5_TOK_HDR_LEN /* encrypted hdr in v2 token */\
205 + GSS_KRB5_MAX_CKSUM_LEN /* encryption hmac */ \
206 + 4 + 4 /* RPC verifier */ \
207 + GSS_KRB5_TOK_HDR_LEN \
208 + GSS_KRB5_MAX_CKSUM_LEN)
211 make_checksum(struct krb5_ctx *kctx, char *header, int hdrlen,
212 struct xdr_buf *body, int body_offset, u8 *cksumkey,
213 struct xdr_netobj *cksumout);
215 u32 gss_get_mic_kerberos(struct gss_ctx *, struct xdr_buf *,
216 struct xdr_netobj *);
218 u32 gss_verify_mic_kerberos(struct gss_ctx *, struct xdr_buf *,
219 struct xdr_netobj *);
222 gss_wrap_kerberos(struct gss_ctx *ctx_id, int offset,
223 struct xdr_buf *outbuf, struct page **pages);
226 gss_unwrap_kerberos(struct gss_ctx *ctx_id, int offset,
227 struct xdr_buf *buf);
231 krb5_encrypt(struct crypto_blkcipher *key,
232 void *iv, void *in, void *out, int length);
235 krb5_decrypt(struct crypto_blkcipher *key,
236 void *iv, void *in, void *out, int length);
239 gss_encrypt_xdr_buf(struct crypto_blkcipher *tfm, struct xdr_buf *outbuf,
240 int offset, struct page **pages);
243 gss_decrypt_xdr_buf(struct crypto_blkcipher *tfm, struct xdr_buf *inbuf,
247 krb5_make_seq_num(struct crypto_blkcipher *key,
249 u32 seqnum, unsigned char *cksum, unsigned char *buf);
252 krb5_get_seq_num(struct crypto_blkcipher *key,
253 unsigned char *cksum,
254 unsigned char *buf, int *direction, u32 *seqnum);
257 xdr_extend_head(struct xdr_buf *buf, unsigned int base, unsigned int shiftlen);
260 krb5_derive_key(const struct gss_krb5_enctype *gk5e,
261 const struct xdr_netobj *inkey,
262 struct xdr_netobj *outkey,
263 const struct xdr_netobj *in_constant);