xref: /openbsd/usr.bin/ssh/monitor.h (revision 856b6ee8)
1 /* $OpenBSD: monitor.h,v 1.25 2024/10/14 01:57:50 djm Exp $ */
2 
3 /*
4  * Copyright 2002 Niels Provos <provos@citi.umich.edu>
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27 
28 #ifndef _MONITOR_H_
29 #define _MONITOR_H_
30 
31 /* Please keep *_REQ_* values on even numbers and *_ANS_* on odd numbers */
32 enum monitor_reqtype {
33 	MONITOR_REQ_MODULI = 0, MONITOR_ANS_MODULI = 1,
34 	MONITOR_REQ_FREE = 2,
35 	MONITOR_REQ_AUTHSERV = 4,
36 	MONITOR_REQ_SIGN = 6, MONITOR_ANS_SIGN = 7,
37 	MONITOR_REQ_PWNAM = 8, MONITOR_ANS_PWNAM = 9,
38 	MONITOR_REQ_AUTH2_READ_BANNER = 10, MONITOR_ANS_AUTH2_READ_BANNER = 11,
39 	MONITOR_REQ_AUTHPASSWORD = 12, MONITOR_ANS_AUTHPASSWORD = 13,
40 	MONITOR_REQ_BSDAUTHQUERY = 14, MONITOR_ANS_BSDAUTHQUERY = 15,
41 	MONITOR_REQ_BSDAUTHRESPOND = 16, MONITOR_ANS_BSDAUTHRESPOND = 17,
42 	MONITOR_REQ_SKEYQUERY = 18, MONITOR_ANS_SKEYQUERY = 19,
43 	MONITOR_REQ_SKEYRESPOND = 20, MONITOR_ANS_SKEYRESPOND = 21,
44 	MONITOR_REQ_KEYALLOWED = 22, MONITOR_ANS_KEYALLOWED = 23,
45 	MONITOR_REQ_KEYVERIFY = 24, MONITOR_ANS_KEYVERIFY = 25,
46 	MONITOR_REQ_KEYEXPORT = 26,
47 	MONITOR_REQ_PTY = 28, MONITOR_ANS_PTY = 29,
48 	MONITOR_REQ_PTYCLEANUP = 30,
49 	MONITOR_REQ_SESSKEY = 32, MONITOR_ANS_SESSKEY = 33,
50 	MONITOR_REQ_SESSID = 34,
51 	MONITOR_REQ_RSAKEYALLOWED = 36, MONITOR_ANS_RSAKEYALLOWED = 37,
52 	MONITOR_REQ_RSACHALLENGE = 38, MONITOR_ANS_RSACHALLENGE = 39,
53 	MONITOR_REQ_RSARESPONSE = 40, MONITOR_ANS_RSARESPONSE = 41,
54 	MONITOR_REQ_GSSSETUP = 42, MONITOR_ANS_GSSSETUP = 43,
55 	MONITOR_REQ_GSSSTEP = 44, MONITOR_ANS_GSSSTEP = 45,
56 	MONITOR_REQ_GSSUSEROK = 46, MONITOR_ANS_GSSUSEROK = 47,
57 	MONITOR_REQ_GSSCHECKMIC = 48, MONITOR_ANS_GSSCHECKMIC = 49,
58 	MONITOR_REQ_TERM = 50,
59 	MONITOR_REQ_STATE = 51, MONITOR_ANS_STATE = 52
60 };
61 
62 struct ssh;
63 struct sshbuf;
64 
65 struct monitor {
66 	int			 m_recvfd;
67 	int			 m_sendfd;
68 	int			 m_log_recvfd;
69 	int			 m_log_sendfd;
70 	struct kex		**m_pkex;
71 	pid_t			 m_pid;
72 };
73 
74 struct monitor *monitor_init(void);
75 void monitor_reinit(struct monitor *);
76 
77 struct Authctxt;
78 void monitor_child_preauth(struct ssh *, struct monitor *);
79 void monitor_child_postauth(struct ssh *, struct monitor *);
80 
81 void monitor_clear_keystate(struct ssh *, struct monitor *);
82 void monitor_apply_keystate(struct ssh *, struct monitor *);
83 
84 /* Prototypes for request sending and receiving */
85 void mm_request_send(int, enum monitor_reqtype, struct sshbuf *);
86 void mm_request_receive(int, struct sshbuf *);
87 void mm_request_receive_expect(int, enum monitor_reqtype, struct sshbuf *);
88 void mm_get_keystate(struct ssh *, struct monitor *);
89 
90 /* XXX: should be returned via a monitor call rather than config_fd */
91 void mm_encode_server_options(struct sshbuf *);
92 
93 struct sshbuf *pack_hostkeys(void);
94 
95 #endif /* _MONITOR_H_ */
96