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