xref: /freebsd/lib/libsecureboot/h/verify_file.h (revision 349cc55c9796c4596a5b9904cd3281af295f878f)
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 #ifndef _VERIFY_FILE_H_
26 #define _VERIFY_FILE_H_
27 
28 #define VE_GUESS        -1           /* let verify_file work it out */
29 #define VE_TRY          0            /* we don't mind if unverified */
30 #define VE_WANT         1            /* we want this verified */
31 #define VE_MUST         2            /* this must be verified */
32 
33 #define VE_NOT_CHECKED -42
34 #define VE_VERIFIED     1            /* all good */
35 #define VE_UNVERIFIED_OK 0           /* not verified but that's ok */
36 #define VE_NOT_VERIFYING 2	     /* we are not verifying */
37 
38 /* suitable buf size for hash_string */
39 #ifndef SHA_DIGEST_LENGTH
40 # define SHA_DIGEST_LENGTH 20
41 #endif
42 
43 struct stat;
44 
45 int	verify_prep(int, const char *, off_t, struct stat *, const char *);
46 void	ve_debug_set(int);
47 char	*ve_error_get(void);
48 void	ve_efi_init(void);
49 int	ve_status_get(int);
50 int	load_manifest(const char *, const char *, const char *, struct stat *);
51 int	pass_manifest(const char *, const char *);
52 int	pass_manifest_export_envs(void);
53 void	verify_report(const char *, int, int, struct stat *);
54 int	verify_file(int, const char *, off_t, int, const char *);
55 void	verify_pcr_export(void);
56 int	hash_string(char *s, size_t n, char *buf, size_t bufsz);
57 int	is_verified(struct stat *);
58 void	add_verify_status(struct stat *, int);
59 
60 struct vectx;
61 struct vectx* vectx_open(int, const char *, off_t, struct stat *, int *, const char *);
62 ssize_t	vectx_read(struct vectx *, void *, size_t);
63 off_t	vectx_lseek(struct vectx *, off_t, int);
64 int	vectx_close(struct vectx *, int, const char *);
65 
66 #endif	/* _VERIFY_FILE_H_ */
67