xref: /illumos-gate/usr/src/uts/common/sys/crypto/elfsign.h (revision 1be2e5dfebda7cac010af97aae7a3a1b45649aed)
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 2007 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #ifndef _SYS_CRYPTO_ELFSIGN_H
27 #define	_SYS_CRYPTO_ELFSIGN_H
28 
29 #pragma ident	"%Z%%M%	%I%	%E% SMI"
30 
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
34 
35 /*
36  * Consolidation Private Interface for elfsign/libpkcs11/kcfd
37  */
38 
39 #include <sys/types.h>
40 #include <sys/param.h>
41 
42 /*
43  * Project Private structures and types used for communication between kcfd
44  * and KCF over the door.
45  */
46 
47 typedef enum ELFsign_status_e {
48 	ELFSIGN_UNKNOWN,
49 	ELFSIGN_SUCCESS,
50 	ELFSIGN_FAILED,
51 	ELFSIGN_NOTSIGNED,
52 	ELFSIGN_INVALID_CERTPATH,
53 	ELFSIGN_INVALID_ELFOBJ,
54 	ELFSIGN_RESTRICTED
55 } ELFsign_status_t;
56 
57 #define	KCF_KCFD_VERSION1	1
58 #define	SIG_MAX_LENGTH		1024
59 
60 #define	ELF_SIGNATURE_SECTION	".SUNW_signature"
61 
62 typedef struct kcf_door_arg_s {
63 	short		da_version;
64 	boolean_t	da_iskernel;
65 
66 	union {
67 		char filename[MAXPATHLEN];	/* For request */
68 
69 		struct kcf_door_result_s {	/* For response */
70 			ELFsign_status_t	status;
71 			uint32_t		siglen;
72 			uchar_t			signature[1];
73 		} result;
74 	} da_u;
75 } kcf_door_arg_t;
76 
77 typedef uint32_t	filesig_vers_t;
78 
79 /*
80  * File Signature Structure
81  *	Applicable to ELF and other file formats
82  */
83 struct filesignatures {
84 	uint32_t	filesig_cnt;	/* count of signatures */
85 	uint32_t	filesig_pad;	/* unused */
86 	union {
87 		char	filesig_data[1];
88 		struct filesig {	/* one of these for each signature */
89 			uint32_t	filesig_size;
90 			filesig_vers_t	filesig_version;
91 			union {
92 				struct filesig_version1 {
93 					uint32_t	filesig_v1_dnsize;
94 					uint32_t	filesig_v1_sigsize;
95 					uint32_t	filesig_v1_oidsize;
96 					char	filesig_v1_data[1];
97 				} filesig_v1;
98 				struct filesig_version3 {
99 					uint64_t	filesig_v3_time;
100 					uint32_t	filesig_v3_dnsize;
101 					uint32_t	filesig_v3_sigsize;
102 					uint32_t	filesig_v3_oidsize;
103 					char	filesig_v3_data[1];
104 				} filesig_v3;
105 			} _u2;
106 		} filesig_sig;
107 		uint64_t filesig_align;
108 	} _u1;
109 };
110 #define	filesig_sig		_u1.filesig_sig
111 
112 #define	filesig_v1_dnsize	_u2.filesig_v1.filesig_v1_dnsize
113 #define	filesig_v1_sigsize	_u2.filesig_v1.filesig_v1_sigsize
114 #define	filesig_v1_oidsize	_u2.filesig_v1.filesig_v1_oidsize
115 #define	filesig_v1_data		_u2.filesig_v1.filesig_v1_data
116 
117 #define	filesig_v3_time		_u2.filesig_v3.filesig_v3_time
118 #define	filesig_v3_dnsize	_u2.filesig_v3.filesig_v3_dnsize
119 #define	filesig_v3_sigsize	_u2.filesig_v3.filesig_v3_sigsize
120 #define	filesig_v3_oidsize	_u2.filesig_v3.filesig_v3_oidsize
121 #define	filesig_v3_data		_u2.filesig_v3.filesig_v3_data
122 
123 #define	filesig_ALIGN(s)	(((s) + sizeof (uint64_t) - 1) & \
124 				    (-sizeof (uint64_t)))
125 #define	filesig_next(ptr)	(struct filesig *)((void *)((char *)(ptr) + \
126 				    filesig_ALIGN((ptr)->filesig_size)))
127 
128 #define	FILESIG_UNKNOWN		0	/* unrecognized version */
129 #define	FILESIG_VERSION1	1	/* version1, all but sig section */
130 #define	FILESIG_VERSION2	2	/* version1 format, SHF_ALLOC only */
131 #define	FILESIG_VERSION3	3	/* version3, all but sig section */
132 #define	FILESIG_VERSION4	4	/* version3 format, SHF_ALLOC only */
133 
134 #ifndef	_KERNEL
135 
136 #define	_PATH_KCFD_DOOR	"/var/run/kcfd_door"
137 
138 #endif	/* _KERNEL */
139 
140 #ifdef __cplusplus
141 }
142 #endif
143 
144 #endif /* _SYS_CRYPTO_ELFSIGN_H */
145