xref: /illumos-gate/usr/src/cmd/cmd-crypto/cryptoadm/cryptoadm.h (revision 6ea3c0609e50782557505b88bb391b786bca32c9)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
23  */
24 /*
25  * Copyright 2010 Nexenta Systems, Inc.  All rights reserved.
26  */
27 
28 #ifndef	_CRYPTOADM_H
29 #define	_CRYPTOADM_H
30 
31 #include <sys/types.h>
32 #include <sys/crypto/ioctladmin.h>
33 #include <cryptoutil.h>
34 #include <security/cryptoki.h>
35 
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39 
40 #define	TMPFILE_TEMPLATE	"/etc/crypto/admXXXXXX"
41 
42 #define	ERROR_USAGE	2
43 
44 #define	HW_PROVIDER_NCP		1
45 #define	HW_PROVIDER_N2CP	2
46 #define	HW_PROVIDER_N2RNG	3
47 
48 /*
49  * Common keywords and delimiters for pkcs11.conf and kcf.conf files are
50  * defined in usr/lib/libcryptoutil/common/cryptoutil.h.  The following is
51  * the extra keywords and delimiters used in kcf.conf file.
52  */
53 #define	SEP_SLASH		'/'
54 #define	EF_SUPPORTED		"supportedlist="
55 #define	EF_UNLOAD		"unload"
56 #define	RANDOM			"random"
57 #define	UEF_FRAME_LIB		"/usr/lib/libpkcs11.so"
58 
59 #define	ADD_MODE	1
60 #define	DELETE_MODE	2
61 #define	MODIFY_MODE	3
62 
63 #define	REFRESH		1
64 #define	NOT_REFRESH	0
65 
66 typedef char prov_name_t[MAXNAMELEN];
67 typedef char mech_name_t[CRYPTO_MAX_MECH_NAME];
68 
69 typedef struct mechlist {
70 	mech_name_t	name;
71 	struct mechlist	*next;
72 } mechlist_t;
73 
74 
75 typedef struct entry {
76 	prov_name_t	name;
77 	mechlist_t	*suplist; /* supported list */
78 	uint_t		sup_count;
79 	mechlist_t	*dislist; /* disabled list */
80 	uint_t		dis_count;
81 	boolean_t	load; /* B_FALSE after cryptoadm unload */
82 } entry_t;
83 
84 
85 typedef struct entrylist {
86 	entry_t	*pent;
87 	struct entrylist *next;
88 } entrylist_t;
89 
90 typedef enum {
91 	NO_RNG,
92 	HAS_RNG
93 } flag_val_t;
94 
95 extern int errno;
96 
97 /* adm_util */
98 extern boolean_t is_in_list(char *, mechlist_t *);
99 extern mechlist_t *create_mech(char *);
100 extern void free_mechlist(mechlist_t *);
101 
102 /* adm_kef_util */
103 extern boolean_t is_device(char *);
104 extern char *ent2str(entry_t *);
105 extern entry_t *getent_kef(char *provname,
106 		entrylist_t *pdevlist, entrylist_t *psoftlist);
107 extern int check_kernel_for_soft(char *provname,
108 		crypto_get_soft_list_t *psoftlist, boolean_t *in_kernel);
109 extern int check_kernel_for_hard(char *provname,
110 		crypto_get_dev_list_t *pdevlist, boolean_t *in_kernel);
111 extern int disable_mechs(entry_t **, mechlist_t *, boolean_t, mechlist_t *);
112 extern int enable_mechs(entry_t **, boolean_t, mechlist_t *);
113 extern int get_kcfconf_info(entrylist_t **, entrylist_t **);
114 extern int get_admindev_info(entrylist_t **, entrylist_t **);
115 extern int get_mech_count(mechlist_t *);
116 extern entry_t *create_entry(char *provname);
117 extern int insert_kcfconf(entry_t *);
118 extern int split_hw_provname(char *, char *, int *);
119 extern int update_kcfconf(entry_t *, int);
120 extern void free_entry(entry_t *);
121 extern void free_entrylist(entrylist_t *);
122 extern void print_mechlist(char *, mechlist_t *);
123 extern void print_kef_policy(char *provname, entry_t *pent,
124 		boolean_t has_random, boolean_t has_mechs);
125 extern boolean_t filter_mechlist(mechlist_t **, const char *);
126 extern uentry_t *getent_uef(char *);
127 
128 
129 /* adm_uef */
130 extern int list_mechlist_for_lib(char *, mechlist_t *, flag_val_t *,
131 		boolean_t, boolean_t, boolean_t);
132 extern int list_policy_for_lib(char *);
133 extern int disable_uef_lib(char *, boolean_t, boolean_t, mechlist_t *);
134 extern int enable_uef_lib(char *, boolean_t, boolean_t, mechlist_t *);
135 extern int install_uef_lib(char *);
136 extern int uninstall_uef_lib(char *);
137 extern int print_uef_policy(uentry_t *);
138 extern void display_token_flags(CK_FLAGS flags);
139 extern int convert_mechlist(CK_MECHANISM_TYPE **, CK_ULONG *, mechlist_t *);
140 extern void display_verbose_mech_header();
141 extern void display_mech_info(CK_MECHANISM_INFO *);
142 extern int display_policy(uentry_t *);
143 extern int update_pkcs11conf(uentry_t *);
144 extern int update_policylist(uentry_t *, mechlist_t *, int);
145 
146 /* adm_kef */
147 extern int list_mechlist_for_soft(char *provname,
148 		entrylist_t *phardlist, entrylist_t *psoftlist);
149 extern int list_mechlist_for_hard(char *);
150 extern int list_policy_for_soft(char *provname,
151 		entrylist_t *phardlist, entrylist_t *psoftlist);
152 extern int list_policy_for_hard(char *provname,
153 		entrylist_t *phardlist, entrylist_t *psoftlist,
154 		crypto_get_dev_list_t *pdevlist);
155 extern int disable_kef_software(char *, boolean_t, boolean_t, mechlist_t *);
156 extern int disable_kef_hardware(char *, boolean_t, boolean_t, mechlist_t *);
157 extern int enable_kef(char *, boolean_t, boolean_t, mechlist_t *);
158 extern int install_kef(char *, mechlist_t *);
159 extern int uninstall_kef(char *);
160 extern int unload_kef_soft(char *provname);
161 extern int refresh(void);
162 
163 /* adm_ioctl */
164 extern crypto_load_soft_config_t *setup_soft_conf(entry_t *);
165 extern crypto_load_soft_disabled_t *setup_soft_dis(entry_t *);
166 extern crypto_load_dev_disabled_t *setup_dev_dis(entry_t *);
167 extern crypto_unload_soft_module_t *setup_unload_soft(entry_t *);
168 extern int get_dev_info(char *, int, int, mechlist_t **);
169 extern int get_dev_list(crypto_get_dev_list_t **);
170 extern int get_soft_info(char *provname, mechlist_t **ppmechlist,
171 		entrylist_t *phardlist, entrylist_t *psoftlist);
172 extern int get_soft_list(crypto_get_soft_list_t **);
173 
174 /* adm_metaslot */
175 extern int list_metaslot_info(boolean_t, boolean_t, mechlist_t *);
176 extern int list_metaslot_policy();
177 extern int disable_metaslot(mechlist_t *, boolean_t, boolean_t);
178 extern int enable_metaslot(char *, char *, boolean_t, mechlist_t *, boolean_t,
179     boolean_t);
180 
181 #ifdef __cplusplus
182 }
183 #endif
184 
185 #endif /* _CRYPTOADM_H */
186