Merge from vendor branch WPA_SUPPLICANT:
[dragonfly.git] / sys / opencrypto / cryptodev.h
1 /*      $FreeBSD: src/sys/opencrypto/cryptodev.h,v 1.2.2.5 2003/06/03 00:09:02 sam Exp $        */
2 /*      $DragonFly: src/sys/opencrypto/cryptodev.h,v 1.2 2003/06/17 04:28:54 dillon Exp $       */
3 /*      $OpenBSD: cryptodev.h,v 1.31 2002/06/11 11:14:29 beck Exp $     */
4
5 /*
6  * The author of this code is Angelos D. Keromytis (angelos@cis.upenn.edu)
7  *
8  * This code was written by Angelos D. Keromytis in Athens, Greece, in
9  * February 2000. Network Security Technologies Inc. (NSTI) kindly
10  * supported the development of this code.
11  *
12  * Copyright (c) 2000 Angelos D. Keromytis
13  *
14  * Permission to use, copy, and modify this software with or without fee
15  * is hereby granted, provided that this entire notice is included in
16  * all source code copies of any software which is or includes a copy or
17  * modification of this software.
18  *
19  * THIS SOFTWARE IS BEING PROVIDED "AS IS", WITHOUT ANY EXPRESS OR
20  * IMPLIED WARRANTY. IN PARTICULAR, NONE OF THE AUTHORS MAKES ANY
21  * REPRESENTATION OR WARRANTY OF ANY KIND CONCERNING THE
22  * MERCHANTABILITY OF THIS SOFTWARE OR ITS FITNESS FOR ANY PARTICULAR
23  * PURPOSE.
24  *
25  * Copyright (c) 2001 Theo de Raadt
26  *
27  * Redistribution and use in source and binary forms, with or without
28  * modification, are permitted provided that the following conditions
29  * are met:
30  *
31  * 1. Redistributions of source code must retain the above copyright
32  *   notice, this list of conditions and the following disclaimer.
33  * 2. Redistributions in binary form must reproduce the above copyright
34  *   notice, this list of conditions and the following disclaimer in the
35  *   documentation and/or other materials provided with the distribution.
36  * 3. The name of the author may not be used to endorse or promote products
37  *   derived from this software without specific prior written permission.
38  *
39  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
40  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
41  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
42  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
43  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
44  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
45  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
46  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
47  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
48  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
49  *
50  * Effort sponsored in part by the Defense Advanced Research Projects
51  * Agency (DARPA) and Air Force Research Laboratory, Air Force
52  * Materiel Command, USAF, under agreement number F30602-01-2-0537.
53  *
54  */
55
56 #ifndef _CRYPTO_CRYPTO_H_
57 #define _CRYPTO_CRYPTO_H_
58
59 #include <sys/ioccom.h>
60
61 /* Some initial values */
62 #define CRYPTO_DRIVERS_INITIAL  4
63 #define CRYPTO_SW_SESSIONS      32
64
65 /* HMAC values */
66 #define HMAC_BLOCK_LEN          64
67 #define HMAC_IPAD_VAL           0x36
68 #define HMAC_OPAD_VAL           0x5C
69
70 /* Encryption algorithm block sizes */
71 #define DES_BLOCK_LEN           8
72 #define DES3_BLOCK_LEN          8
73 #define BLOWFISH_BLOCK_LEN      8
74 #define SKIPJACK_BLOCK_LEN      8
75 #define CAST128_BLOCK_LEN       8
76 #define RIJNDAEL128_BLOCK_LEN   16
77 #define EALG_MAX_BLOCK_LEN      16 /* Keep this updated */
78
79 /* Maximum hash algorithm result length */
80 #define AALG_MAX_RESULT_LEN     64 /* Keep this updated */
81
82 #define CRYPTO_ALGORITHM_MIN    1
83 #define CRYPTO_DES_CBC          1
84 #define CRYPTO_3DES_CBC         2
85 #define CRYPTO_BLF_CBC          3
86 #define CRYPTO_CAST_CBC         4
87 #define CRYPTO_SKIPJACK_CBC     5
88 #define CRYPTO_MD5_HMAC         6
89 #define CRYPTO_SHA1_HMAC        7
90 #define CRYPTO_RIPEMD160_HMAC   8
91 #define CRYPTO_MD5_KPDK         9
92 #define CRYPTO_SHA1_KPDK        10
93 #define CRYPTO_RIJNDAEL128_CBC  11 /* 128 bit blocksize */
94 #define CRYPTO_AES_CBC          11 /* 128 bit blocksize -- the same as above */
95 #define CRYPTO_ARC4             12
96 #define CRYPTO_MD5              13
97 #define CRYPTO_SHA1             14
98 #define CRYPTO_SHA2_HMAC        15
99 #define CRYPTO_NULL_HMAC        16
100 #define CRYPTO_NULL_CBC         17
101 #define CRYPTO_DEFLATE_COMP     18 /* Deflate compression algorithm */
102 #define CRYPTO_ALGORITHM_MAX    18 /* Keep updated - see below */
103
104 /* Algorithm flags */
105 #define CRYPTO_ALG_FLAG_SUPPORTED       0x01 /* Algorithm is supported */
106 #define CRYPTO_ALG_FLAG_RNG_ENABLE      0x02 /* Has HW RNG for DH/DSA */
107 #define CRYPTO_ALG_FLAG_DSA_SHA         0x04 /* Can do SHA on msg */
108
109 struct session_op {
110         u_int32_t       cipher;         /* ie. CRYPTO_DES_CBC */
111         u_int32_t       mac;            /* ie. CRYPTO_MD5_HMAC */
112
113         u_int32_t       keylen;         /* cipher key */
114         caddr_t         key;
115         int             mackeylen;      /* mac key */
116         caddr_t         mackey;
117
118         u_int32_t       ses;            /* returns: session # */ 
119 };
120
121 struct crypt_op {
122         u_int32_t       ses;
123         u_int16_t       op;             /* i.e. COP_ENCRYPT */
124 #define COP_ENCRYPT     1
125 #define COP_DECRYPT     2
126         u_int16_t       flags;
127 #define COP_F_BATCH     0x0008          /* Dispatch as quickly as possible */
128         u_int           len;
129         caddr_t         src, dst;       /* become iov[] inside kernel */
130         caddr_t         mac;            /* must be big enough for chosen MAC */
131         caddr_t         iv;
132 };
133
134 #define CRYPTO_MAX_MAC_LEN      20
135
136 /* bignum parameter, in packed bytes, ... */
137 struct crparam {
138         caddr_t         crp_p;
139         u_int           crp_nbits;
140 };
141
142 #define CRK_MAXPARAM    8
143
144 struct crypt_kop {
145         u_int           crk_op;         /* ie. CRK_MOD_EXP or other */
146         u_int           crk_status;     /* return status */
147         u_short         crk_iparams;    /* # of input parameters */
148         u_short         crk_oparams;    /* # of output parameters */
149         u_int           crk_pad1;
150         struct crparam  crk_param[CRK_MAXPARAM];
151 };
152 #define CRK_ALGORITM_MIN        0
153 #define CRK_MOD_EXP             0
154 #define CRK_MOD_EXP_CRT         1
155 #define CRK_DSA_SIGN            2
156 #define CRK_DSA_VERIFY          3
157 #define CRK_DH_COMPUTE_KEY      4
158 #define CRK_ALGORITHM_MAX       4 /* Keep updated - see below */
159
160 #define CRF_MOD_EXP             (1 << CRK_MOD_EXP)
161 #define CRF_MOD_EXP_CRT         (1 << CRK_MOD_EXP_CRT)
162 #define CRF_DSA_SIGN            (1 << CRK_DSA_SIGN)
163 #define CRF_DSA_VERIFY          (1 << CRK_DSA_VERIFY)
164 #define CRF_DH_COMPUTE_KEY      (1 << CRK_DH_COMPUTE_KEY)
165
166 /*
167  * done against open of /dev/crypto, to get a cloned descriptor.
168  * Please use F_SETFD against the cloned descriptor.
169  */
170 #define CRIOGET         _IOWR('c', 100, u_int32_t)
171
172 /* the following are done against the cloned descriptor */
173 #define CIOCGSESSION    _IOWR('c', 101, struct session_op)
174 #define CIOCFSESSION    _IOW('c', 102, u_int32_t)
175 #define CIOCCRYPT       _IOWR('c', 103, struct crypt_op)
176 #define CIOCKEY         _IOWR('c', 104, struct crypt_kop)
177
178 #define CIOCASYMFEAT    _IOR('c', 105, u_int32_t)
179
180 struct cryptotstat {
181         struct timespec acc;            /* total accumulated time */
182         struct timespec min;            /* max time */
183         struct timespec max;            /* max time */
184         u_int32_t       count;          /* number of observations */
185 };
186
187 struct cryptostats {
188         u_int32_t       cs_ops;         /* symmetric crypto ops submitted */
189         u_int32_t       cs_errs;        /* symmetric crypto ops that failed */
190         u_int32_t       cs_kops;        /* asymetric/key ops submitted */
191         u_int32_t       cs_kerrs;       /* asymetric/key ops that failed */
192         u_int32_t       cs_intrs;       /* crypto swi thread activations */
193         u_int32_t       cs_rets;        /* crypto return thread activations */
194         u_int32_t       cs_blocks;      /* symmetric op driver block */
195         u_int32_t       cs_kblocks;     /* symmetric op driver block */
196         /*
197          * When CRYPTO_TIMING is defined at compile time and the
198          * sysctl debug.crypto is set to 1, the crypto system will
199          * accumulate statistics about how long it takes to process
200          * crypto requests at various points during processing.
201          */
202         struct cryptotstat cs_invoke;   /* crypto_dipsatch -> crypto_invoke */
203         struct cryptotstat cs_done;     /* crypto_invoke -> crypto_done */
204         struct cryptotstat cs_cb;       /* crypto_done -> callback */
205         struct cryptotstat cs_finis;    /* callback -> callback return */
206 };
207
208 #ifdef _KERNEL
209 /* Standard initialization structure beginning */
210 struct cryptoini {
211         int             cri_alg;        /* Algorithm to use */
212         int             cri_klen;       /* Key length, in bits */
213         int             cri_rnd;        /* Algorithm rounds, where relevant */
214         caddr_t         cri_key;        /* key to use */
215         u_int8_t        cri_iv[EALG_MAX_BLOCK_LEN];     /* IV to use */
216         struct cryptoini *cri_next;
217 };
218
219 /* Describe boundaries of a single crypto operation */
220 struct cryptodesc {
221         int             crd_skip;       /* How many bytes to ignore from start */
222         int             crd_len;        /* How many bytes to process */
223         int             crd_inject;     /* Where to inject results, if applicable */
224         int             crd_flags;
225
226 #define CRD_F_ENCRYPT           0x01    /* Set when doing encryption */
227 #define CRD_F_IV_PRESENT        0x02    /* When encrypting, IV is already in
228                                            place, so don't copy. */
229 #define CRD_F_IV_EXPLICIT       0x04    /* IV explicitly provided */
230 #define CRD_F_DSA_SHA_NEEDED    0x08    /* Compute SHA-1 of buffer for DSA */
231 #define CRD_F_COMP              0x0f    /* Set when doing compression */
232
233         struct cryptoini        CRD_INI; /* Initialization/context data */
234 #define crd_iv          CRD_INI.cri_iv
235 #define crd_key         CRD_INI.cri_key
236 #define crd_rnd         CRD_INI.cri_rnd
237 #define crd_alg         CRD_INI.cri_alg
238 #define crd_klen        CRD_INI.cri_klen
239
240         struct cryptodesc *crd_next;
241 };
242
243 /* Structure describing complete operation */
244 struct cryptop {
245         TAILQ_ENTRY(cryptop) crp_next;
246
247         u_int64_t       crp_sid;        /* Session ID */
248         int             crp_ilen;       /* Input data total length */
249         int             crp_olen;       /* Result total length */
250
251         int             crp_etype;      /*
252                                          * Error type (zero means no error).
253                                          * All error codes except EAGAIN
254                                          * indicate possible data corruption (as in,
255                                          * the data have been touched). On all
256                                          * errors, the crp_sid may have changed
257                                          * (reset to a new one), so the caller
258                                          * should always check and use the new
259                                          * value on future requests.
260                                          */
261         int             crp_flags;
262
263 #define CRYPTO_F_IMBUF  0x0001  /* Input/output are mbuf chains, otherwise contig */
264 #define CRYPTO_F_IOV    0x0002  /* Input/output are uio */
265 #define CRYPTO_F_REL    0x0004  /* Must return data in same place */
266 #define CRYPTO_F_BATCH  0x0008  /* Batch op if possible possible */
267 #define CRYPTO_F_CBIMM  0x0010  /* Do callback immediately */
268 #define CRYPTO_F_DONE   0x0020  /* Operation completed */
269
270         caddr_t         crp_buf;        /* Data to be processed */
271         caddr_t         crp_opaque;     /* Opaque pointer, passed along */
272         struct cryptodesc *crp_desc;    /* Linked list of processing descriptors */
273
274         int (*crp_callback)(struct cryptop *); /* Callback function */
275
276         caddr_t         crp_mac;
277         struct timespec crp_tstamp;     /* performance time stamp */
278 };
279
280 #define CRYPTO_BUF_CONTIG       0x0
281 #define CRYPTO_BUF_IOV          0x1
282 #define CRYPTO_BUF_MBUF         0x2
283
284 #define CRYPTO_OP_DECRYPT       0x0
285 #define CRYPTO_OP_ENCRYPT       0x1
286
287 /*
288  * Hints passed to process methods.
289  */
290 #define CRYPTO_HINT_MORE        0x1     /* more ops coming shortly */
291
292 struct cryptkop {
293         TAILQ_ENTRY(cryptkop) krp_next;
294
295         u_int           krp_op;         /* ie. CRK_MOD_EXP or other */
296         u_int           krp_status;     /* return status */
297         u_short         krp_iparams;    /* # of input parameters */
298         u_short         krp_oparams;    /* # of output parameters */
299         u_int32_t       krp_hid;
300         struct crparam  krp_param[CRK_MAXPARAM];        /* kvm */
301         int             (*krp_callback)(struct cryptkop *);
302 };
303
304 /* Crypto capabilities structure */
305 struct cryptocap {
306         u_int32_t       cc_sessions;
307
308         /*
309          * Largest possible operator length (in bits) for each type of
310          * encryption algorithm.
311          */
312         u_int16_t       cc_max_op_len[CRYPTO_ALGORITHM_MAX + 1];
313
314         u_int8_t        cc_alg[CRYPTO_ALGORITHM_MAX + 1];
315
316         u_int8_t        cc_kalg[CRK_ALGORITHM_MAX + 1];
317
318         u_int8_t        cc_flags;
319         u_int8_t        cc_qblocked;            /* symmetric q blocked */
320         u_int8_t        cc_kqblocked;           /* asymmetric q blocked */
321 #define CRYPTOCAP_F_CLEANUP   0x1
322 #define CRYPTOCAP_F_SOFTWARE  0x02
323
324         void            *cc_arg;                /* callback argument */
325         int             (*cc_newsession)(void*, u_int32_t*, struct cryptoini*);
326         int             (*cc_process)(void*, struct cryptop *, int);
327         int             (*cc_freesession)(void*, u_int64_t);
328         void            *cc_karg;               /* callback argument */
329         int             (*cc_kprocess) (void*, struct cryptkop *, int);
330 };
331
332 MALLOC_DECLARE(M_CRYPTO_DATA);
333
334 extern  int crypto_newsession(u_int64_t *sid, struct cryptoini *cri, int hard);
335 extern  int crypto_freesession(u_int64_t sid);
336 extern  int32_t crypto_get_driverid(u_int32_t flags);
337 extern  int crypto_register(u_int32_t driverid, int alg, u_int16_t maxoplen,
338             u_int32_t flags,
339             int (*newses)(void*, u_int32_t*, struct cryptoini*),
340             int (*freeses)(void*, u_int64_t),
341             int (*process)(void*, struct cryptop *, int),
342             void *arg);
343 extern  int crypto_kregister(u_int32_t, int, u_int32_t,
344             int (*)(void*, struct cryptkop *, int),
345             void *arg);
346 extern  int crypto_unregister(u_int32_t driverid, int alg);
347 extern  int crypto_unregister_all(u_int32_t driverid);
348 extern  int crypto_dispatch(struct cryptop *crp);
349 extern  int crypto_kdispatch(struct cryptkop *);
350 #define CRYPTO_SYMQ     0x1
351 #define CRYPTO_ASYMQ    0x2
352 extern  int crypto_unblock(u_int32_t, int);
353 extern  void crypto_done(struct cryptop *crp);
354 extern  void crypto_kdone(struct cryptkop *);
355 extern  int crypto_getfeat(int *);
356
357 extern  void crypto_freereq(struct cryptop *crp);
358 extern  struct cryptop *crypto_getreq(int num);
359
360 extern  int crypto_usercrypto;          /* userland may do crypto requests */
361 extern  int crypto_userasymcrypto;      /* userland may do asym crypto reqs */
362 extern  int crypto_devallowsoft;        /* only use hardware crypto */
363
364 /*
365  * Crypto-related utility routines used mainly by drivers.
366  *
367  * XXX these don't really belong here; but for now they're
368  *     kept apart from the rest of the system.
369  */
370 struct mbuf;
371 struct  mbuf    *m_getptr(struct mbuf *, int, int *);
372
373 struct uio;
374 extern  void cuio_copydata(struct uio* uio, int off, int len, caddr_t cp);
375 extern  void cuio_copyback(struct uio* uio, int off, int len, caddr_t cp);
376 extern  struct iovec *cuio_getptr(struct uio *uio, int loc, int *off);
377 #endif /* _KERNEL */
378 #endif /* _CRYPTO_CRYPTO_H_ */