xref: /xnu-12377.41.6/bsd/netinet6/ah.h (revision bbb1b6f9e71b8cdde6e5cd6f4841f207dee3d828)
1 /*	$FreeBSD: src/sys/netinet6/ah.h,v 1.3.2.2 2001/07/03 11:01:49 ume Exp $	*/
2 /*	$KAME: ah.h,v 1.13 2000/10/18 21:28:00 itojun Exp $	*/
3 
4 /*
5  * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. Neither the name of the project nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  */
32 
33 /*
34  * RFC1826/2402 authentication header.
35  */
36 
37 #ifndef _NETINET6_AH_H_
38 #define _NETINET6_AH_H_
39 #include <sys/appleapiopts.h>
40 
41 #include <sys/types.h>
42 
43 #ifdef BSD_KERNEL_PRIVATE
44 #include <corecrypto/cchmac.h>
45 #include <corecrypto/ccsha2.h>
46 #endif /* BSD_KERNEL_PRIVATE */
47 
48 struct ah {
49 	u_int8_t        ah_nxt;         /* Next Header */
50 	u_int8_t        ah_len;         /* Length of data, in 32bit */
51 	u_int16_t       ah_reserve;     /* Reserved for future use */
52 	u_int32_t       ah_spi;         /* Security parameter index */
53 	/* variable size, 32bit bound*/	/* Authentication data */
54 };
55 
56 struct newah {
57 	u_int8_t        ah_nxt;         /* Next Header */
58 	u_int8_t        ah_len;         /* Length of data + 1, in 32bit */
59 	u_int16_t       ah_reserve;     /* Reserved for future use */
60 	u_int32_t       ah_spi;         /* Security parameter index */
61 	u_int32_t       ah_seq;         /* Sequence number field */
62 	/* variable size, 32bit bound*/	/* Authentication data */
63 };
64 
65 #ifdef BSD_KERNEL_PRIVATE
66 struct secasvar;
67 
68 struct ah_algorithm_state {
69 	const struct ccdigest_info *digest;
70 	cchmac_ctx_decl(CCSHA512_STATE_SIZE, CCSHA512_BLOCK_SIZE, hmac_ctx);
71 };
72 
73 struct ah_algorithm {
74 	int (*sumsiz)(struct secasvar *);
75 	int (*mature)(struct secasvar *);
76 	u_int16_t keymin;     /* in bits */
77 	u_int16_t keymax;     /* in bits */
78 	const char *name;
79 	int (*init)(struct ah_algorithm_state *, struct secasvar *);
80 	void (*update)(struct ah_algorithm_state *, caddr_t, size_t);
81 	void (*result)(struct ah_algorithm_state *, caddr_t, size_t);
82 	/* not supposed to be called directly */
83 	const struct ccdigest_info *(*digest)(void);
84 	size_t (*schedlen)(const struct ah_algorithm *);
85 	int (*schedule)(const struct ah_algorithm *, struct secasvar *);
86 };
87 
88 #define AH_MAXSUMSIZE   64 // sha2-512's output size
89 
90 extern const struct ah_algorithm *ah_algorithm_lookup(int);
91 
92 /* cksum routines */
93 extern size_t ah_hdrlen(struct secasvar *);
94 extern size_t ah_hdrsiz(struct ipsecrequest *);
95 extern int ah_schedule(const struct ah_algorithm *, struct secasvar *);
96 
97 extern void ah4_input(struct mbuf *, int);
98 extern int ah4_output(struct mbuf *, struct secasvar *);
99 extern int ah4_calccksum(struct mbuf *, caddr_t __sized_by(len), size_t len,
100     const struct ah_algorithm *, struct secasvar *);
101 #endif /* BSD_KERNEL_PRIVATE */
102 
103 #endif /* _NETINET6_AH_H_ */
104