xref: /freebsd/lib/libveriexec/veriexec.3 (revision 43a5ec4eb41567cc92586503212743d89686d78f)
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.\" $FreeBSD$
26.\"
27.Dd June 19, 2018
28.Dt VERIEXEC 3
29.Os
30.Sh NAME
31.Nm veriexec_check_fd ,
32.Nm veriexec_check_path
33.Nd Verified execution routines
34.Sh LIBRARY
35.Lb libveriexec
36.Sh SYNOPSIS
37.In libveriexec.h
38.Ft int
39.Fn veriexec_check_fd "int fd"
40.Ft int
41.Fn veriexec_check_path "const char *file"
42.Sh DESCRIPTION
43The
44.Fn veriexec_check_fd
45function checks the signature of the file represented by the
46.Fa fd
47file descriptor.
48.Pp
49The
50.Fn veriexec_check_path
51function checks the signature of the file path
52.Fa file .
53.Pp
54The
55.Fn veriexec_check_fd
56and
57.Fn veriexec_check_path
58functions return zero on a successful signature match or if veriexec is not
59enabled.
60If the signature does not match,
61.Va errno
62is set to the reason for the mismatch.
63.Sh SEE ALSO
64.Xr mac_veriexec 4
65.Xr veriexec 4
66