gss_krb5.h 11 KB

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