master
1/*-
2 * SPDX-License-Identifier: BSD-2-Clause
3 *
4 * Copyright (c) 2020 Rick Macklem
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 * SUCH DAMAGE.
26 */
27
28#ifndef _RPC_RPCSEC_TLS_H_
29#define _RPC_RPCSEC_TLS_H_
30
31/* Operation values for rpctls syscall. */
32#define RPCTLS_SYSC_CLSETPATH 1
33#define RPCTLS_SYSC_CLSOCKET 2
34#define RPCTLS_SYSC_CLSHUTDOWN 3
35#define RPCTLS_SYSC_SRVSETPATH 4
36#define RPCTLS_SYSC_SRVSOCKET 5
37#define RPCTLS_SYSC_SRVSHUTDOWN 6
38#define RPCTLS_SYSC_SRVSTARTUP 7
39
40/* Max nprocs for SRV startup */
41#define RPCTLS_SRV_MAXNPROCS 16
42
43/* System call used by the rpctlscd, rpctlssd daemons. */
44int rpctls_syscall(int, const char *);
45
46/* Flag bits to indicate certificate results. */
47#define RPCTLS_FLAGS_HANDSHAKE 0x01
48#define RPCTLS_FLAGS_GOTCERT 0x02
49#define RPCTLS_FLAGS_SELFSIGNED 0x04
50#define RPCTLS_FLAGS_VERIFIED 0x08
51#define RPCTLS_FLAGS_DISABLED 0x10
52#define RPCTLS_FLAGS_CERTUSER 0x20
53#define RPCTLS_FLAGS_HANDSHFAIL 0x40
54
55/* Error return values for upcall rpcs. */
56#define RPCTLSERR_OK 0
57#define RPCTLSERR_NOCLOSE 1
58#define RPCTLSERR_NOSSL 2
59#define RPCTLSERR_NOSOCKET 3
60
61#ifdef _KERNEL
62/* Functions that perform upcalls to the rpctlsd daemon. */
63enum clnt_stat rpctls_connect(CLIENT *newclient, char *certname,
64 struct socket *so, uint64_t *sslp, uint32_t *reterr);
65enum clnt_stat rpctls_cl_handlerecord(uint64_t sec, uint64_t usec,
66 uint64_t ssl, uint32_t *reterr);
67enum clnt_stat rpctls_srv_handlerecord(uint64_t sec, uint64_t usec,
68 uint64_t ssl, int procpos, uint32_t *reterr);
69enum clnt_stat rpctls_cl_disconnect(uint64_t sec, uint64_t usec,
70 uint64_t ssl, uint32_t *reterr);
71enum clnt_stat rpctls_srv_disconnect(uint64_t sec, uint64_t usec,
72 uint64_t ssl, int procpos, uint32_t *reterr);
73
74/* Initialization function for rpcsec_tls. */
75int rpctls_init(void);
76
77/* Get TLS information function. */
78bool rpctls_getinfo(u_int *maxlen, bool rpctlscd_run,
79 bool rpctlssd_run);
80
81/* String for AUTH_TLS reply verifier. */
82#define RPCTLS_START_STRING "STARTTLS"
83
84/* ssl refno value to indicate TLS handshake being done. */
85#define RPCTLS_REFNO_HANDSHAKE 0xFFFFFFFFFFFFFFFFULL
86
87/* Macros for VIMAGE. */
88/* Just define the KRPC_VNETxxx() macros as VNETxxx() macros. */
89#define KRPC_VNET_NAME(n) VNET_NAME(n)
90#define KRPC_VNET_DECLARE(t, n) VNET_DECLARE(t, n)
91#define KRPC_VNET_DEFINE(t, n) VNET_DEFINE(t, n)
92#define KRPC_VNET_DEFINE_STATIC(t, n) VNET_DEFINE_STATIC(t, n)
93#define KRPC_VNET(n) VNET(n)
94
95#define CTLFLAG_KRPC_VNET CTLFLAG_VNET
96
97#define KRPC_CURVNET_SET(n) CURVNET_SET(n)
98#define KRPC_CURVNET_SET_QUIET(n) CURVNET_SET_QUIET(n)
99#define KRPC_CURVNET_RESTORE() CURVNET_RESTORE()
100#define KRPC_TD_TO_VNET(n) TD_TO_VNET(n)
101
102#endif /* _KERNEL */
103
104#endif /* _RPC_RPCSEC_TLS_H_ */