xref: /freebsd/lib/libsecureboot/h/libsecureboot.h (revision 3c5ca68b9b7ce68a5376b8456edf6af57ed18f91)
1 /*-
2  * Copyright (c) 2017-2018, Juniper Networks, Inc.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
14  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
15  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
16  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
17  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
18  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
19  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25 /*
26  */
27 #ifndef _LIBSECUREBOOT_H_
28 #define _LIBSECUREBOOT_H_
29 
30 #undef MIN	/* Conflicts with EDK2 */
31 #undef MAX
32 #include <sys/param.h>
33 #ifdef _STANDALONE
34 #define _DEBUG_LEVEL_VAR DebugVe
35 #include <stand.h>
36 #else
37 #include <sys/types.h>
38 #include <sys/stat.h>
39 #include <stdlib.h>
40 #include <stdio.h>
41 #include <unistd.h>
42 #include <fcntl.h>
43 #endif
44 
45 #include <bearssl.h>
46 
47 unsigned char * read_fd(int, size_t);
48 #ifndef NEED_BRSSL_H
49 unsigned char * read_file(const char *, size_t *);
50 #endif
51 
52 extern int DebugVe;
53 extern int VerifyFlags;
54 
55 #ifndef DEBUG_PRINTF
56 #define DEBUG_PRINTF(n, x) if (DebugVe >= n) printf x
57 #endif
58 
59 int ve_trust_init(void);
60 size_t ve_trust_anchors_add_buf(unsigned char *, size_t);
61 size_t ve_trust_anchors_revoke(unsigned char *, size_t);
62 int ve_trust_add(const char *);
63 void ve_debug_set(int);
64 void ve_enforce_validity_set(int);
65 void ve_anchor_verbose_set(int);
66 int ve_anchor_verbose_get(void);
67 void ve_utc_set(time_t utc);
68 char *ve_error_get(void);
69 int ve_error_set(const char *, ...) __printflike(1,2);
70 int  ve_self_tests(void);
71 
72 void fingerprint_info_add(const char *, const char *, const char *,
73     const char *, struct stat *);
74 
75 char * hexdigest(char *, size_t, unsigned char *, size_t);
76 int  verify_fd(int, const char *, off_t, struct stat *);
77 int  verify_open(const char *, int);
78 
79 unsigned char *verify_signed(const char *, int);
80 unsigned char *verify_sig(const char *, int);
81 unsigned char *verify_asc(const char *, int); /* OpenPGP */
82 
83 void ve_pcr_init(void);
84 void ve_pcr_update(const char *, unsigned char *, size_t);
85 ssize_t ve_pcr_get(unsigned char *, size_t);
86 int ve_pcr_updating_get(void);
87 void ve_pcr_updating_set(int);
88 char * ve_pcr_hashed_get(int);
89 
90 /* flags for verify_{asc,sig,signed} */
91 #define VEF_VERBOSE		1
92 
93 #define VE_FINGERPRINT_OK	1
94 #define VE_FINGERPRINT_IGNORE	2
95 /* errors from verify_fd */
96 #define VE_FINGERPRINT_NONE	-2
97 #define VE_FINGERPRINT_WRONG	-3
98 #define VE_FINGERPRINT_UNKNOWN	-4	/* may not be an error */
99 
100 #endif	/* _LIBSECUREBOOT_H_ */
101