[BACK]Return to packet.h CVS log [TXT][DIR] Up to [local] / src / usr.bin / ssh

Annotation of src/usr.bin/ssh/packet.h, Revision 1.74

1.74    ! djm         1: /* $OpenBSD: packet.h,v 1.73 2016/09/30 09:19:13 markus Exp $ */
1.33      stevesk     2:
1.1       deraadt     3: /*
1.5       deraadt     4:  * Author: Tatu Ylonen <ylo@cs.hut.fi>
                      5:  * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
                      6:  *                    All rights reserved
                      7:  * Interface for the packet protocol functions.
1.15      markus      8:  *
1.17      deraadt     9:  * As far as I am concerned, the code I have written for this software
                     10:  * can be used freely for any purpose.  Any derived versions of this
                     11:  * software must be clearly marked as such, and if the derived work is
                     12:  * incompatible with the protocol description in the RFC file, it must be
                     13:  * called by a name other than "ssh" or "Secure Shell".
1.5       deraadt    14:  */
1.1       deraadt    15:
                     16: #ifndef PACKET_H
                     17: #define PACKET_H
1.44      stevesk    18:
                     19: #include <termios.h>
1.1       deraadt    20:
1.13      markus     21: #include <openssl/bn.h>
1.54      djm        22: #include <openssl/ec.h>
1.62      markus     23: #include <sys/signal.h>
                     24: #include <sys/queue.h>
1.1       deraadt    25:
1.62      markus     26: struct kex;
                     27: struct sshkey;
                     28: struct sshbuf;
                     29: struct session_state;  /* private session data */
                     30:
1.63      markus     31: #include "dispatch.h"  /* typedef, DISPATCH_MAX */
                     32:
1.64      markus     33: struct key_entry {
                     34:        TAILQ_ENTRY(key_entry) next;
                     35:        struct sshkey *key;
                     36: };
                     37:
1.62      markus     38: struct ssh {
                     39:        /* Session state */
                     40:        struct session_state *state;
                     41:
                     42:        /* Key exchange */
                     43:        struct kex *kex;
                     44:
1.71      djm        45:        /* cached local and remote ip addresses and ports */
1.62      markus     46:        char *remote_ipaddr;
                     47:        int remote_port;
1.71      djm        48:        char *local_ipaddr;
                     49:        int local_port;
1.63      markus     50:
                     51:        /* Dispatcher table */
                     52:        dispatch_fn *dispatch[DISPATCH_MAX];
                     53:        /* number of packets to ignore in the dispatcher */
                     54:        int dispatch_skip_packets;
1.62      markus     55:
                     56:        /* datafellows */
                     57:        int compat;
1.64      markus     58:
                     59:        /* Lists for private and public keys */
                     60:        TAILQ_HEAD(, key_entry) private_keys;
                     61:        TAILQ_HEAD(, key_entry) public_keys;
                     62:
                     63:        /* APP data */
                     64:        void *app_data;
1.62      markus     65: };
                     66:
1.74    ! djm        67: typedef int (ssh_packet_hook_fn)(struct ssh *, struct sshbuf *,
        !            68:     u_char *, void *);
        !            69:
1.62      markus     70: struct ssh *ssh_alloc_session_state(void);
                     71: struct ssh *ssh_packet_set_connection(struct ssh *, int, int);
                     72: void     ssh_packet_set_timeout(struct ssh *, int, int);
                     73: int     ssh_packet_stop_discard(struct ssh *);
                     74: int     ssh_packet_connection_af(struct ssh *);
                     75: void     ssh_packet_set_nonblocking(struct ssh *);
                     76: int      ssh_packet_get_connection_in(struct ssh *);
                     77: int      ssh_packet_get_connection_out(struct ssh *);
                     78: void     ssh_packet_close(struct ssh *);
                     79: void    ssh_packet_set_encryption_key(struct ssh *, const u_char *, u_int, int);
1.74    ! djm        80: void    ssh_packet_set_input_hook(struct ssh *, ssh_packet_hook_fn *, void *);
        !            81:
1.70      djm        82: int     ssh_packet_is_rekeying(struct ssh *);
1.62      markus     83: void     ssh_packet_set_protocol_flags(struct ssh *, u_int);
                     84: u_int   ssh_packet_get_protocol_flags(struct ssh *);
                     85: int      ssh_packet_start_compression(struct ssh *, int);
                     86: void    ssh_packet_set_tos(struct ssh *, int);
                     87: void     ssh_packet_set_interactive(struct ssh *, int, int, int);
                     88: int      ssh_packet_is_interactive(struct ssh *);
                     89: void     ssh_packet_set_server(struct ssh *);
                     90: void     ssh_packet_set_authenticated(struct ssh *);
1.73      markus     91: void     ssh_packet_set_mux(struct ssh *);
                     92: int     ssh_packet_get_mux(struct ssh *);
                     93:
                     94: int     ssh_packet_log_type(u_char);
1.62      markus     95:
                     96: int     ssh_packet_send1(struct ssh *);
                     97: int     ssh_packet_send2_wrapped(struct ssh *);
                     98: int     ssh_packet_send2(struct ssh *);
                     99:
                    100: int      ssh_packet_read(struct ssh *);
1.66      djm       101: int     ssh_packet_read_expect(struct ssh *, u_int type);
1.62      markus    102: int      ssh_packet_read_poll(struct ssh *);
                    103: int ssh_packet_read_poll1(struct ssh *, u_char *);
                    104: int ssh_packet_read_poll2(struct ssh *, u_char *, u_int32_t *seqnr_p);
1.65      djm       105: int     ssh_packet_process_incoming(struct ssh *, const char *buf, u_int len);
1.62      markus    106: int      ssh_packet_read_seqnr(struct ssh *, u_char *, u_int32_t *seqnr_p);
                    107: int      ssh_packet_read_poll_seqnr(struct ssh *, u_char *, u_int32_t *seqnr_p);
                    108:
                    109: const void *ssh_packet_get_string_ptr(struct ssh *, u_int *length_ptr);
                    110: void     ssh_packet_disconnect(struct ssh *, const char *fmt, ...)
                    111:        __attribute__((format(printf, 2, 3)))
                    112:        __attribute__((noreturn));
                    113: void     ssh_packet_send_debug(struct ssh *, const char *fmt, ...) __attribute__((format(printf, 2, 3)));
                    114:
                    115: int     ssh_set_newkeys(struct ssh *, int mode);
                    116: void    ssh_packet_get_bytes(struct ssh *, u_int64_t *, u_int64_t *);
                    117:
1.66      djm       118: int     ssh_packet_write_poll(struct ssh *);
                    119: int     ssh_packet_write_wait(struct ssh *);
1.62      markus    120: int      ssh_packet_have_data_to_write(struct ssh *);
                    121: int      ssh_packet_not_very_much_data_to_write(struct ssh *);
                    122:
                    123: int     ssh_packet_connection_is_on_socket(struct ssh *);
                    124: int     ssh_packet_remaining(struct ssh *);
                    125: void    ssh_packet_send_ignore(struct ssh *, int);
1.1       deraadt   126:
1.25      markus    127: void    tty_make_modes(int, struct termios *);
                    128: void    tty_parse_modes(int, int *);
1.1       deraadt   129:
1.62      markus    130: void    ssh_packet_set_alive_timeouts(struct ssh *, int);
                    131: int     ssh_packet_inc_alive_timeouts(struct ssh *);
                    132: int     ssh_packet_set_maxsize(struct ssh *, u_int);
                    133: u_int   ssh_packet_get_maxsize(struct ssh *);
                    134:
                    135: int     ssh_packet_get_state(struct ssh *, struct sshbuf *);
                    136: int     ssh_packet_set_state(struct ssh *, struct sshbuf *);
                    137:
                    138: const char *ssh_remote_ipaddr(struct ssh *);
1.67      djm       139: int     ssh_remote_port(struct ssh *);
1.71      djm       140: const char *ssh_local_ipaddr(struct ssh *);
                    141: int     ssh_local_port(struct ssh *);
1.62      markus    142:
1.69      dtucker   143: void    ssh_packet_set_rekey_limits(struct ssh *, u_int64_t, time_t);
1.62      markus    144: time_t  ssh_packet_get_rekey_timeout(struct ssh *);
                    145:
                    146: void   *ssh_packet_get_input(struct ssh *);
                    147: void   *ssh_packet_get_output(struct ssh *);
                    148:
                    149: /* new API */
                    150: int    sshpkt_start(struct ssh *ssh, u_char type);
                    151: int    sshpkt_send(struct ssh *ssh);
1.66      djm       152: int     sshpkt_disconnect(struct ssh *, const char *fmt, ...)
                    153:            __attribute__((format(printf, 2, 3)));
1.62      markus    154: int    sshpkt_add_padding(struct ssh *, u_char);
1.66      djm       155: void   sshpkt_fatal(struct ssh *ssh, const char *tag, int r);
1.62      markus    156:
                    157: int    sshpkt_put(struct ssh *ssh, const void *v, size_t len);
                    158: int    sshpkt_putb(struct ssh *ssh, const struct sshbuf *b);
                    159: int    sshpkt_put_u8(struct ssh *ssh, u_char val);
                    160: int    sshpkt_put_u32(struct ssh *ssh, u_int32_t val);
                    161: int    sshpkt_put_u64(struct ssh *ssh, u_int64_t val);
                    162: int    sshpkt_put_string(struct ssh *ssh, const void *v, size_t len);
                    163: int    sshpkt_put_cstring(struct ssh *ssh, const void *v);
                    164: int    sshpkt_put_stringb(struct ssh *ssh, const struct sshbuf *v);
                    165: int    sshpkt_put_ec(struct ssh *ssh, const EC_POINT *v, const EC_GROUP *g);
                    166: int    sshpkt_put_bignum1(struct ssh *ssh, const BIGNUM *v);
                    167: int    sshpkt_put_bignum2(struct ssh *ssh, const BIGNUM *v);
                    168:
                    169: int    sshpkt_get(struct ssh *ssh, void *valp, size_t len);
                    170: int    sshpkt_get_u8(struct ssh *ssh, u_char *valp);
                    171: int    sshpkt_get_u32(struct ssh *ssh, u_int32_t *valp);
                    172: int    sshpkt_get_u64(struct ssh *ssh, u_int64_t *valp);
                    173: int    sshpkt_get_string(struct ssh *ssh, u_char **valp, size_t *lenp);
                    174: int    sshpkt_get_string_direct(struct ssh *ssh, const u_char **valp, size_t *lenp);
                    175: int    sshpkt_get_cstring(struct ssh *ssh, char **valp, size_t *lenp);
                    176: int    sshpkt_get_ec(struct ssh *ssh, EC_POINT *v, const EC_GROUP *g);
                    177: int    sshpkt_get_bignum1(struct ssh *ssh, BIGNUM *v);
                    178: int    sshpkt_get_bignum2(struct ssh *ssh, BIGNUM *v);
                    179: int    sshpkt_get_end(struct ssh *ssh);
                    180: const u_char   *sshpkt_ptr(struct ssh *, size_t *lenp);
                    181:
                    182: /* OLD API */
                    183: extern struct ssh *active_state;
                    184: #include "opacket.h"
1.1       deraadt   185:
1.5       deraadt   186: #endif                         /* PACKET_H */