xref: /onnv-gate/usr/src/lib/libwanbootutil/common/key_util.h (revision 0:68f95e015346)
1*0Sstevel@tonic-gate /*
2*0Sstevel@tonic-gate  * CDDL HEADER START
3*0Sstevel@tonic-gate  *
4*0Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*0Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*0Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*0Sstevel@tonic-gate  * with the License.
8*0Sstevel@tonic-gate  *
9*0Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*0Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*0Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*0Sstevel@tonic-gate  * and limitations under the License.
13*0Sstevel@tonic-gate  *
14*0Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*0Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*0Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*0Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*0Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*0Sstevel@tonic-gate  *
20*0Sstevel@tonic-gate  * CDDL HEADER END
21*0Sstevel@tonic-gate  */
22*0Sstevel@tonic-gate /*
23*0Sstevel@tonic-gate  * Copyright 2003 Sun Microsystems, Inc.  All rights reserved.
24*0Sstevel@tonic-gate  * Use is subject to license terms.
25*0Sstevel@tonic-gate  */
26*0Sstevel@tonic-gate 
27*0Sstevel@tonic-gate #ifndef	_KEY_UTIL_H
28*0Sstevel@tonic-gate #define	_KEY_UTIL_H
29*0Sstevel@tonic-gate 
30*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
31*0Sstevel@tonic-gate 
32*0Sstevel@tonic-gate #include <stdio.h>
33*0Sstevel@tonic-gate #include <sys/types.h>
34*0Sstevel@tonic-gate 
35*0Sstevel@tonic-gate #ifdef	__cplusplus
36*0Sstevel@tonic-gate extern "C" {
37*0Sstevel@tonic-gate #endif
38*0Sstevel@tonic-gate 
39*0Sstevel@tonic-gate /* Key algorithms */
40*0Sstevel@tonic-gate typedef enum {
41*0Sstevel@tonic-gate 	WBKU_KEY_3DES,
42*0Sstevel@tonic-gate 	WBKU_KEY_AES_128,
43*0Sstevel@tonic-gate 	WBKU_KEY_HMAC_SHA1,
44*0Sstevel@tonic-gate 	WBKU_KEY_RSA,
45*0Sstevel@tonic-gate 	WBKU_KEY_UNKNOWN
46*0Sstevel@tonic-gate } wbku_key_type_t;
47*0Sstevel@tonic-gate 
48*0Sstevel@tonic-gate /* Algorithm keywords */
49*0Sstevel@tonic-gate #define	WBKU_KW_3DES		"3des"
50*0Sstevel@tonic-gate #define	WBKU_KW_AES_128		"aes"
51*0Sstevel@tonic-gate #define	WBKU_KW_HMAC_SHA1	"sha1"
52*0Sstevel@tonic-gate #define	WBKU_KW_RSA		"rsa"
53*0Sstevel@tonic-gate 
54*0Sstevel@tonic-gate /* Algorithm types */
55*0Sstevel@tonic-gate #define	WBKU_ENCR_KEY	(uint_t)0x1
56*0Sstevel@tonic-gate #define	WBKU_HASH_KEY	(uint_t)0x2
57*0Sstevel@tonic-gate #define	WBKU_ANY_KEY	(WBKU_ENCR_KEY | WBKU_HASH_KEY)
58*0Sstevel@tonic-gate 
59*0Sstevel@tonic-gate /* Return codes */
60*0Sstevel@tonic-gate typedef enum {
61*0Sstevel@tonic-gate 	WBKU_SUCCESS,
62*0Sstevel@tonic-gate 	WBKU_INTERNAL_ERR,
63*0Sstevel@tonic-gate 	WBKU_WRITE_ERR,
64*0Sstevel@tonic-gate 	WBKU_NOKEY,
65*0Sstevel@tonic-gate 	WBKU_BAD_KEYTYPE
66*0Sstevel@tonic-gate } wbku_retcode_t;
67*0Sstevel@tonic-gate 
68*0Sstevel@tonic-gate #define	WBKU_NRET		(WBKU_BAD_KEYTYPE + 1)
69*0Sstevel@tonic-gate 
70*0Sstevel@tonic-gate /* The master key file location. */
71*0Sstevel@tonic-gate #define	MASTER_KEY_FILE	"/etc/netboot/keystore"
72*0Sstevel@tonic-gate 
73*0Sstevel@tonic-gate /* The root directory for all client keys */
74*0Sstevel@tonic-gate #define	CLIENT_KEY_DIR	"/etc/netboot"
75*0Sstevel@tonic-gate 
76*0Sstevel@tonic-gate /* The structure that defines the attributes of a particular key type */
77*0Sstevel@tonic-gate typedef struct key_attr {
78*0Sstevel@tonic-gate 	wbku_key_type_t ka_type; /* key type */
79*0Sstevel@tonic-gate 	uint_t ka_atype;	/* key algorithm type */
80*0Sstevel@tonic-gate 	uint_t ka_len;		/* length of the current key */
81*0Sstevel@tonic-gate 	uint_t ka_minlen;	/* shortest allowable key value */
82*0Sstevel@tonic-gate 	uint_t ka_maxlen;	/* maximum allowable key length */
83*0Sstevel@tonic-gate 	char *ka_str;		/* key string identifier */
84*0Sstevel@tonic-gate 	char *ka_oid;		/* key algorithm oid */
85*0Sstevel@tonic-gate 	boolean_t (*ka_keycheck)(const uint8_t *); /* keycheck function */
86*0Sstevel@tonic-gate } wbku_key_attr_t;
87*0Sstevel@tonic-gate 
88*0Sstevel@tonic-gate extern void wbku_errinit(const char *);
89*0Sstevel@tonic-gate extern void wbku_printerr(const char *, ...);
90*0Sstevel@tonic-gate extern const char *wbku_retmsg(wbku_retcode_t);
91*0Sstevel@tonic-gate extern wbku_retcode_t wbku_str_to_keyattr(const char *, wbku_key_attr_t *,
92*0Sstevel@tonic-gate     uint_t);
93*0Sstevel@tonic-gate extern wbku_retcode_t wbku_find_key(FILE *, fpos_t *, wbku_key_attr_t *,
94*0Sstevel@tonic-gate     uint8_t *, boolean_t);
95*0Sstevel@tonic-gate extern wbku_retcode_t wbku_write_key(FILE *, const fpos_t *,
96*0Sstevel@tonic-gate     const wbku_key_attr_t *, uint8_t *, boolean_t);
97*0Sstevel@tonic-gate extern wbku_retcode_t wbku_delete_key(FILE *, FILE *, const wbku_key_attr_t *);
98*0Sstevel@tonic-gate 
99*0Sstevel@tonic-gate #ifdef	__cplusplus
100*0Sstevel@tonic-gate }
101*0Sstevel@tonic-gate #endif
102*0Sstevel@tonic-gate 
103*0Sstevel@tonic-gate #endif	/* _KEY_UTIL_H */
104