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

Annotation of src/usr.bin/ssh/misc.h, Revision 1.86

1.86    ! dtucker     1: /* $OpenBSD: misc.h,v 1.85 2020/05/26 01:06:52 djm Exp $ */
1.2       niklas      2:
1.1       markus      3: /*
                      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:  *
                      8:  * As far as I am concerned, the code I have written for this software
                      9:  * can be used freely for any purpose.  Any derived versions of this
                     10:  * software must be clearly marked as such, and if the derived work is
                     11:  * incompatible with the protocol description in the RFC file, it must be
                     12:  * called by a name other than "ssh" or "Secure Shell".
                     13:  */
1.10      markus     14:
1.31      djm        15: #ifndef _MISC_H
                     16: #define _MISC_H
1.58      guenther   17:
                     18: #include <sys/time.h>
1.62      djm        19: #include <sys/types.h>
1.78      djm        20: #include <sys/socket.h>
1.31      djm        21:
1.54      millert    22: /* Data structure for representing a forwarding request. */
                     23: struct Forward {
                     24:        char     *listen_host;          /* Host (address) to listen on. */
                     25:        int       listen_port;          /* Port to forward. */
                     26:        char     *listen_path;          /* Path to bind domain socket. */
                     27:        char     *connect_host;         /* Host to connect. */
                     28:        int       connect_port;         /* Port to connect on connect_host. */
                     29:        char     *connect_path;         /* Path to connect domain socket. */
                     30:        int       allocated_port;       /* Dynamically allocated listen port */
                     31:        int       handle;               /* Handle for dynamic listen ports */
                     32: };
1.56      djm        33:
                     34: int forward_equals(const struct Forward *, const struct Forward *);
1.61      dtucker    35: int daemonized(void);
1.54      millert    36:
                     37: /* Common server and client forwarding options. */
                     38: struct ForwardOptions {
                     39:        int      gateway_ports; /* Allow remote connects to forwarded ports. */
                     40:        mode_t   streamlocal_bind_mask; /* umask for streamlocal binds */
                     41:        int      streamlocal_bind_unlink; /* unlink socket before bind */
                     42: };
                     43:
1.14      djm        44: /* misc.c */
                     45:
1.9       itojun     46: char   *chop(char *);
1.80      djm        47: void   skip_space(char **);
1.9       itojun     48: char   *strdelim(char **);
1.73      djm        49: char   *strdelimw(char **);
1.15      djm        50: int     set_nonblock(int);
                     51: int     unset_nonblock(int);
1.11      stevesk    52: void    set_nodelay(int);
1.66      djm        53: int     set_reuseaddr(int);
1.67      djm        54: char   *get_rdomain(int);
1.66      djm        55: int     set_rdomain(int, const char *);
1.78      djm        56: int     waitrfd(int, int *);
                     57: int     timeout_connect(int, const struct sockaddr *, socklen_t, int *);
1.10      markus     58: int     a2port(const char *);
1.27      reyk       59: int     a2tun(const char *, int *);
1.33      dtucker    60: char   *put_host_port(const char *, u_short);
1.79      dtucker    61: char   *hpdelim2(char **, char *);
1.21      djm        62: char   *hpdelim(char **);
1.10      markus     63: char   *cleanhostname(char *);
                     64: char   *colon(char *);
1.64      millert    65: int     parse_user_host_path(const char *, char **, char **, char **);
1.57      djm        66: int     parse_user_host_port(const char *, char **, char **, int *);
1.64      millert    67: int     parse_uri(const char *, const char *, char **, char **, int *, char **);
1.10      markus     68: long    convtime(const char *);
1.85      djm        69: const char *fmt_timeframe(time_t t);
1.22      djm        70: char   *tilde_expand_filename(const char *, uid_t);
1.86    ! dtucker    71:
        !            72: char   *dollar_expand(int *, const char *string);
1.25      dtucker    73: char   *percent_expand(const char *, ...) __attribute__((__sentinel__));
1.86    ! dtucker    74: char   *percent_dollar_expand(const char *, ...) __attribute__((__sentinel__));
1.31      djm        75: char   *tohex(const void *, size_t);
1.84      djm        76: void    xextendf(char **s, const char *sep, const char *fmt, ...)
                     77:     __attribute__((__format__ (printf, 3, 4))) __attribute__((__nonnull__ (3)));
1.26      djm        78: void    sanitise_stdfd(void);
1.38      dtucker    79: void    ms_subtract_diff(struct timeval *, int *);
                     80: void    ms_to_timeval(struct timeval *, int);
1.68      dtucker    81: void    monotime_ts(struct timespec *);
                     82: void    monotime_tv(struct timeval *);
1.49      dtucker    83: time_t  monotime(void);
1.55      dtucker    84: double  monotime_double(void);
1.50      djm        85: void    lowercase(char *s);
1.54      millert    86: int     unix_listener(const char *, int, int);
1.64      millert    87: int     valid_domain(char *, int, const char **);
1.75      djm        88: int     valid_env_name(const char *);
1.69      dtucker    89: const char *atoi_err(const char *, int *);
1.71      djm        90: int     parse_absolute_time(const char *, uint64_t *);
                     91: void    format_absolute_time(uint64_t, char *, size_t);
1.76      djm        92: int     path_absolute(const char *);
1.1       markus     93:
1.10      markus     94: struct passwd *pwcopy(struct passwd *);
1.37      dtucker    95: const char *ssh_gai_strerror(int);
1.5       mouring    96:
1.6       mouring    97: typedef struct arglist arglist;
                     98: struct arglist {
1.12      markus     99:        char    **list;
1.17      avsm      100:        u_int   num;
                    101:        u_int   nalloc;
1.6       mouring   102: };
1.29      djm       103: void    addargs(arglist *, char *, ...)
                    104:             __attribute__((format(printf, 2, 3)));
                    105: void    replacearg(arglist *, u_int, char *, ...)
                    106:             __attribute__((format(printf, 3, 4)));
                    107: void    freeargs(arglist *);
1.14      djm       108:
1.65      djm       109: int     tun_open(int, int, char **);
1.28      reyk      110:
                    111: /* Common definitions for ssh tunnel device forwarding */
                    112: #define SSH_TUNMODE_NO         0x00
                    113: #define SSH_TUNMODE_POINTOPOINT        0x01
                    114: #define SSH_TUNMODE_ETHERNET   0x02
                    115: #define SSH_TUNMODE_DEFAULT    SSH_TUNMODE_POINTOPOINT
                    116: #define SSH_TUNMODE_YES                (SSH_TUNMODE_POINTOPOINT|SSH_TUNMODE_ETHERNET)
                    117:
                    118: #define SSH_TUNID_ANY          0x7fffffff
                    119: #define SSH_TUNID_ERR          (SSH_TUNID_ANY - 1)
                    120: #define SSH_TUNID_MAX          (SSH_TUNID_ANY - 2)
1.54      millert   121:
                    122: /* Fake port to indicate that host field is really a path. */
                    123: #define PORT_STREAMLOCAL       -2
1.31      djm       124:
                    125: /* Functions to extract or store big-endian words of various sizes */
                    126: u_int64_t      get_u64(const void *)
1.53      djm       127:     __attribute__((__bounded__( __minbytes__, 1, 8)));
1.31      djm       128: u_int32_t      get_u32(const void *)
1.53      djm       129:     __attribute__((__bounded__( __minbytes__, 1, 4)));
1.31      djm       130: u_int16_t      get_u16(const void *)
1.53      djm       131:     __attribute__((__bounded__( __minbytes__, 1, 2)));
1.31      djm       132: void           put_u64(void *, u_int64_t)
1.53      djm       133:     __attribute__((__bounded__( __minbytes__, 1, 8)));
1.31      djm       134: void           put_u32(void *, u_int32_t)
1.53      djm       135:     __attribute__((__bounded__( __minbytes__, 1, 4)));
1.31      djm       136: void           put_u16(void *, u_int16_t)
1.53      djm       137:     __attribute__((__bounded__( __minbytes__, 1, 2)));
1.52      djm       138:
                    139: /* Little-endian store/load, used by umac.c */
                    140: u_int32_t      get_u32_le(const void *)
1.53      djm       141:     __attribute__((__bounded__(__minbytes__, 1, 4)));
1.52      djm       142: void           put_u32_le(void *, u_int32_t)
1.53      djm       143:     __attribute__((__bounded__(__minbytes__, 1, 4)));
1.44      djm       144:
                    145: struct bwlimit {
                    146:        size_t buflen;
1.77      dtucker   147:        u_int64_t rate;         /* desired rate in kbit/s */
                    148:        u_int64_t thresh;       /* threshold after which we'll check timers */
                    149:        u_int64_t lamt;         /* amount written in last timer interval */
1.44      djm       150:        struct timeval bwstart, bwend;
                    151: };
                    152:
                    153: void bandwidth_limit_init(struct bwlimit *, u_int64_t, size_t);
                    154: void bandwidth_limit(struct bwlimit *, size_t);
1.31      djm       155:
1.46      djm       156: int parse_ipqos(const char *);
1.48      stevesk   157: const char *iptos2str(int);
1.47      djm       158: void mktemp_proto(char *, size_t);
1.62      djm       159:
                    160: void    child_set_env(char ***envp, u_int *envsizep, const char *name,
                    161:             const char *value);
                    162:
                    163: int     argv_split(const char *, int *, char ***);
                    164: char   *argv_assemble(int, char **argv);
1.63      djm       165: int     exited_cleanly(pid_t, const char *, const char *, int);
1.62      djm       166:
                    167: struct stat;
                    168: int     safe_path(const char *, struct stat *, const char *, uid_t,
                    169:             char *, size_t);
                    170: int     safe_path_fd(int, const char *, struct passwd *,
                    171:             char *err, size_t errlen);
1.81      djm       172:
                    173: /* authorized_key-style options parsing helpers */
                    174: int    opt_flag(const char *opt, int allow_negate, const char **optsp);
                    175: char   *opt_dequote(const char **sp, const char **errstrp);
                    176: int    opt_match(const char **opts, const char *term);
1.36      djm       177:
                    178: /* readpass.c */
                    179:
                    180: #define RP_ECHO                        0x0001
                    181: #define RP_ALLOW_STDIN         0x0002
                    182: #define RP_ALLOW_EOF           0x0004
                    183: #define RP_USE_ASKPASS         0x0008
                    184:
1.82      djm       185: struct notifier_ctx;
                    186:
1.36      djm       187: char   *read_passphrase(const char *, int);
                    188: int     ask_permission(const char *, ...) __attribute__((format(printf, 1, 2)));
1.82      djm       189: struct notifier_ctx *notify_start(int, const char *, ...)
                    190:        __attribute__((format(printf, 2, 3)));
                    191: void   notify_complete(struct notifier_ctx *);
1.59      deraadt   192:
                    193: #define MINIMUM(a, b)  (((a) < (b)) ? (a) : (b))
                    194: #define MAXIMUM(a, b)  (((a) > (b)) ? (a) : (b))
                    195: #define ROUNDUP(x, y)   ((((x)+((y)-1))/(y))*(y))
1.36      djm       196:
1.83      dtucker   197: typedef void (*sshsig_t)(int);
                    198: sshsig_t ssh_signal(int, sshsig_t);
1.31      djm       199: #endif /* _MISC_H */