Home | History | Annotate | Line # | Download | only in dist
      1 /*	$NetBSD: monitor.h,v 1.16 2026/04/08 18:58:41 christos Exp $	*/
      2 /* $OpenBSD: monitor.h,v 1.28 2026/03/02 02:40:15 djm Exp $ */
      3 
      4 /*
      5  * Copyright 2002 Niels Provos <provos (at) citi.umich.edu>
      6  * All rights reserved.
      7  *
      8  * Redistribution and use in source and binary forms, with or without
      9  * modification, are permitted provided that the following conditions
     10  * are met:
     11  * 1. Redistributions of source code must retain the above copyright
     12  *    notice, this list of conditions and the following disclaimer.
     13  * 2. Redistributions in binary form must reproduce the above copyright
     14  *    notice, this list of conditions and the following disclaimer in the
     15  *    documentation and/or other materials provided with the distribution.
     16  *
     17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
     18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
     19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
     20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
     21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
     22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
     26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     27  */
     28 
     29 #ifndef _MONITOR_H_
     30 #define _MONITOR_H_
     31 
     32 /* Please keep *_REQ_* values on even numbers and *_ANS_* on odd numbers */
     33 enum monitor_reqtype {
     34 	MONITOR_REQ_MODULI = 0, MONITOR_ANS_MODULI = 1,
     35 	MONITOR_REQ_FREE = 2,
     36 	MONITOR_REQ_AUTHSERV = 4,
     37 	MONITOR_REQ_SIGN = 6, MONITOR_ANS_SIGN = 7,
     38 	MONITOR_REQ_PWNAM = 8, MONITOR_ANS_PWNAM = 9,
     39 	MONITOR_REQ_AUTH2_READ_BANNER = 10, MONITOR_ANS_AUTH2_READ_BANNER = 11,
     40 	MONITOR_REQ_AUTHPASSWORD = 12, MONITOR_ANS_AUTHPASSWORD = 13,
     41 	MONITOR_REQ_BSDAUTHQUERY = 14, MONITOR_ANS_BSDAUTHQUERY = 15,
     42 	MONITOR_REQ_BSDAUTHRESPOND = 16, MONITOR_ANS_BSDAUTHRESPOND = 17,
     43 	MONITOR_REQ_SETCOMPAT = 18,
     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 	MONITOR_REQ_PAM_START = 100,
     62 	MONITOR_REQ_PAM_ACCOUNT = 102, MONITOR_ANS_PAM_ACCOUNT = 103,
     63 	MONITOR_REQ_PAM_INIT_CTX = 104, MONITOR_ANS_PAM_INIT_CTX = 105,
     64 	MONITOR_REQ_PAM_QUERY = 106, MONITOR_ANS_PAM_QUERY = 107,
     65 	MONITOR_REQ_PAM_RESPOND = 108, MONITOR_ANS_PAM_RESPOND = 109,
     66 	MONITOR_REQ_PAM_FREE_CTX = 110, MONITOR_ANS_PAM_FREE_CTX = 111,
     67 	MONITOR_REQ_AUDIT_EVENT = 112, MONITOR_REQ_AUDIT_COMMAND = 113,
     68 
     69 	MONITOR_REQ_KRB4 = 200, MONITOR_ANS_KRB4 = 201,
     70 	MONITOR_REQ_KRB5 = 202, MONITOR_ANS_KRB5 = 203,
     71 };
     72 
     73 struct ssh;
     74 struct sshbuf;
     75 
     76 struct monitor {
     77 	int			 m_recvfd;
     78 	int			 m_sendfd;
     79 	int			 m_log_recvfd;
     80 	int			 m_log_sendfd;
     81 	struct kex		**m_pkex;
     82 	pid_t			 m_pid;
     83 };
     84 
     85 struct monitor *monitor_init(void);
     86 void monitor_reinit(struct monitor *);
     87 
     88 struct Authctxt;
     89 void monitor_child_preauth(struct ssh *, struct monitor *);
     90 void monitor_child_postauth(struct ssh *, struct monitor *)
     91     __attribute__((__noreturn__));
     92 
     93 void monitor_clear_keystate(struct ssh *, struct monitor *);
     94 void monitor_apply_keystate(struct ssh *, struct monitor *);
     95 
     96 int  monitor_auth_attempted(void);
     97 int  monitor_invalid_user(void);
     98 
     99 /* Prototypes for request sending and receiving */
    100 void mm_request_send(int, enum monitor_reqtype, struct sshbuf *);
    101 void mm_request_receive(int, struct sshbuf *);
    102 void mm_request_receive_expect(int, enum monitor_reqtype, struct sshbuf *);
    103 void mm_get_keystate(struct ssh *, struct monitor *);
    104 
    105 /* XXX: should be returned via a monitor call rather than config_fd */
    106 void mm_encode_server_options(struct sshbuf *);
    107 
    108 struct sshbuf *pack_hostkeys(void);
    109 
    110 #endif /* _MONITOR_H_ */
    111