xref: /freebsd/lib/libveriexec/veriexec.3 (revision 87bf66d4a7488c496af110d4d05cc0273d49f82e)
1.\" Copyright (c) 2018, Juniper Networks, Inc.
2.\" All rights reserved.
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 AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.Dd June 19, 2018
26.Dt VERIEXEC 3
27.Os
28.Sh NAME
29.Nm veriexec_check_fd ,
30.Nm veriexec_check_path
31.Nd Verified execution routines
32.Sh LIBRARY
33.Lb libveriexec
34.Sh SYNOPSIS
35.In libveriexec.h
36.Ft int
37.Fn veriexec_check_fd "int fd"
38.Ft int
39.Fn veriexec_check_path "const char *file"
40.Sh DESCRIPTION
41The
42.Fn veriexec_check_fd
43function checks the signature of the file represented by the
44.Fa fd
45file descriptor.
46.Pp
47The
48.Fn veriexec_check_path
49function checks the signature of the file path
50.Fa file .
51.Pp
52The
53.Fn veriexec_check_fd
54and
55.Fn veriexec_check_path
56functions return zero on a successful signature match or if veriexec is not
57enabled.
58If the signature does not match,
59.Va errno
60is set to the reason for the mismatch.
61.Sh SEE ALSO
62.Xr mac_veriexec 4 ,
63.Xr veriexec 4
64