xref: /titanic_41/usr/src/cmd/cmd-crypto/cryptoadm/cryptoadm.h (revision e802abbda8c322f24d47835734f4a793ef15ddc8)
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 2008 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #ifndef	_CRYPTOADM_H
27 #define	_CRYPTOADM_H
28 
29 #include <sys/types.h>
30 #include <sys/crypto/ioctladmin.h>
31 #include <cryptoutil.h>
32 #include <security/cryptoki.h>
33 
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37 
38 #define	_PATH_KCF_CONF		"/etc/crypto/kcf.conf"
39 #define	_PATH_KCFD		"/lib/crypto/kcfd"
40 #define	TMPFILE_TEMPLATE	"/etc/crypto/admXXXXXX"
41 
42 #define	ERROR_USAGE	2
43 
44 /*
45  * Common keywords and delimiters for pkcs11.conf and kcf.conf files are
46  * defined in usr/lib/libcryptoutil/common/cryptoutil.h.  The following is
47  * the extra keywords and delimiters used in kcf.conf file.
48  */
49 #define	SEP_SLASH		'/'
50 #define	EF_SUPPORTED		"supportedlist="
51 #define	EF_UNLOAD		"unload"
52 #define	RANDOM			"random"
53 #define	UEF_FRAME_LIB		"/usr/lib/libpkcs11.so"
54 
55 #define	ADD_MODE	1
56 #define	DELETE_MODE	2
57 #define	MODIFY_MODE	3
58 
59 typedef char prov_name_t[MAXNAMELEN];
60 typedef char mech_name_t[CRYPTO_MAX_MECH_NAME];
61 
62 typedef struct mechlist {
63 	mech_name_t	name;
64 	struct mechlist	*next;
65 } mechlist_t;
66 
67 
68 typedef struct entry {
69 	prov_name_t	name;
70 	mechlist_t	*suplist; /* supported list */
71 	uint_t		sup_count;
72 	mechlist_t	*dislist; /* disabled list */
73 	uint_t		dis_count;
74 	boolean_t	load; /* B_FALSE after cryptoadm unload */
75 } entry_t;
76 
77 
78 typedef struct entrylist {
79 	entry_t	*pent;
80 	struct entrylist *next;
81 } entrylist_t;
82 
83 typedef enum {
84 	NO_RNG,
85 	HAS_RNG
86 } flag_val_t;
87 
88 extern int errno;
89 
90 /* adm_util */
91 extern boolean_t is_in_list(char *, mechlist_t *);
92 extern mechlist_t *create_mech(char *);
93 extern void free_mechlist(mechlist_t *);
94 
95 /* adm_kef_util */
96 extern boolean_t is_device(char *);
97 extern char *ent2str(entry_t *);
98 extern entry_t *getent_kef(char *provname,
99 		entrylist_t *pdevlist, entrylist_t *psoftlist);
100 extern int check_kernel_for_soft(char *provname,
101 		crypto_get_soft_list_t *psoftlist, boolean_t *in_kernel);
102 extern int check_kernel_for_hard(char *provname,
103 		crypto_get_dev_list_t *pdevlist, boolean_t *in_kernel);
104 extern int disable_mechs(entry_t **, mechlist_t *, boolean_t, mechlist_t *);
105 extern int enable_mechs(entry_t **, boolean_t, mechlist_t *);
106 extern int get_kcfconf_info(entrylist_t **, entrylist_t **);
107 extern int get_admindev_info(entrylist_t **, entrylist_t **);
108 extern int get_mech_count(mechlist_t *);
109 extern entry_t *create_entry(char *provname);
110 extern int insert_kcfconf(entry_t *);
111 extern int split_hw_provname(char *, char *, int *);
112 extern int update_kcfconf(entry_t *, int);
113 extern void free_entry(entry_t *);
114 extern void free_entrylist(entrylist_t *);
115 extern void print_mechlist(char *, mechlist_t *);
116 extern void print_kef_policy(char *provname, entry_t *pent,
117 		boolean_t has_random, boolean_t has_mechs);
118 extern boolean_t filter_mechlist(mechlist_t **, const char *);
119 extern uentry_t *getent_uef(char *);
120 
121 
122 /* adm_uef */
123 extern int list_mechlist_for_lib(char *, mechlist_t *, flag_val_t *,
124 		boolean_t, boolean_t, boolean_t);
125 extern int list_policy_for_lib(char *);
126 extern int disable_uef_lib(char *, boolean_t, boolean_t, mechlist_t *);
127 extern int enable_uef_lib(char *, boolean_t, boolean_t, mechlist_t *);
128 extern int install_uef_lib(char *);
129 extern int uninstall_uef_lib(char *);
130 extern int print_uef_policy(uentry_t *);
131 extern void display_token_flags(CK_FLAGS flags);
132 extern int convert_mechlist(CK_MECHANISM_TYPE **, CK_ULONG *, mechlist_t *);
133 extern void display_verbose_mech_header();
134 extern void display_mech_info(CK_MECHANISM_INFO *);
135 extern int display_policy(uentry_t *);
136 extern int update_pkcs11conf(uentry_t *);
137 extern int update_policylist(uentry_t *, mechlist_t *, int);
138 
139 /* adm_kef */
140 extern int list_mechlist_for_soft(char *provname,
141 		entrylist_t *phardlist, entrylist_t *psoftlist);
142 extern int list_mechlist_for_hard(char *);
143 extern int list_policy_for_soft(char *provname,
144 		entrylist_t *phardlist, entrylist_t *psoftlist);
145 extern int list_policy_for_hard(char *provname,
146 		entrylist_t *phardlist, entrylist_t *psoftlist,
147 		crypto_get_dev_list_t *pdevlist);
148 extern int disable_kef_software(char *, boolean_t, boolean_t, mechlist_t *);
149 extern int disable_kef_hardware(char *, boolean_t, boolean_t, mechlist_t *);
150 extern int enable_kef(char *, boolean_t, boolean_t, mechlist_t *);
151 extern int install_kef(char *, mechlist_t *);
152 extern int uninstall_kef(char *);
153 extern int unload_kef_soft(char *provname);
154 extern int refresh(void);
155 extern int start_daemon(void);
156 extern int stop_daemon(void);
157 
158 /* adm_ioctl */
159 extern crypto_load_soft_config_t *setup_soft_conf(entry_t *);
160 extern crypto_load_soft_disabled_t *setup_soft_dis(entry_t *);
161 extern crypto_load_dev_disabled_t *setup_dev_dis(entry_t *);
162 extern crypto_unload_soft_module_t *setup_unload_soft(entry_t *);
163 extern int get_dev_info(char *, int, int, mechlist_t **);
164 extern int get_dev_list(crypto_get_dev_list_t **);
165 extern int get_soft_info(char *provname, mechlist_t **ppmechlist,
166 		entrylist_t *phardlist, entrylist_t *psoftlist);
167 extern int get_soft_list(crypto_get_soft_list_t **);
168 
169 /* adm_metaslot */
170 extern int list_metaslot_info(boolean_t, boolean_t, mechlist_t *);
171 extern int list_metaslot_policy();
172 extern int disable_metaslot(mechlist_t *, boolean_t, boolean_t);
173 extern int enable_metaslot(char *, char *, boolean_t, mechlist_t *, boolean_t,
174     boolean_t);
175 
176 #ifdef __cplusplus
177 }
178 #endif
179 
180 #endif /* _CRYPTOADM_H */
181