misc.h

   1 /* $OpenBSD: misc.h,v 1.34 2006/08/01 23:22:47 stevesk Exp $ */
   2
   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  */
  14
  15 #ifndef _MISC_H
  16 #define _MISC_H
  17
  18 #include <sys/types.h>
  19
  20 #include <pwd.h>
  21 #include <stdio.h>
  22
  23 /* misc.c */
  24
  25 char    *chop(char *);
  26 char    *strdelim(char **);
  27 int      set_nonblock(int);
  28 int      unset_nonblock(int);
  29 void     set_nodelay(int);
  30 int      a2port(const char *);
  31 int      a2tun(const char *, int *);
  32 char    *put_host_port(const char *, u_short);
  33 char    *hpdelim(char **);
  34 char    *cleanhostname(char *);
  35 char    *colon(char *);
  36 long     convtime(const char *);
  37 char    *tilde_expand_filename(const char *, uid_t);
  38 char    *percent_expand(const char *, ...) __attribute__((__sentinel__));
  39 char    *tohex(const void *, size_t);
  40 void     sanitise_stdfd(void);
  41
  42 struct passwd *pwcopy(struct passwd *);
  43
  44 typedef struct arglist arglist;
  45 struct arglist {
  46         char    **list;
  47         u_int   num;
  48         u_int   nalloc;
  49 };
  50 void     addargs(arglist *, char *, ...)
  51              __attribute__((format(printf, 2, 3)));
  52 void     replacearg(arglist *, u_int, char *, ...)
  53              __attribute__((format(printf, 3, 4)));
  54 void     freeargs(arglist *);
  55
  56 /* readpass.c */
  57
  58 #define RP_ECHO                 0x0001
  59 #define RP_ALLOW_STDIN          0x0002
  60 #define RP_ALLOW_EOF            0x0004
  61 #define RP_USE_ASKPASS          0x0008
  62
  63 char    *read_passphrase(const char *, int);
  64 int      ask_permission(const char *, ...) __attribute__((format(printf, 1, 2)));
  65 int      read_keyfile_line(FILE *, const char *, char *, size_t, u_long *);
  66
  67 int      tun_open(int, int);
  68
  69 /* Common definitions for ssh tunnel device forwarding */
  70 #define SSH_TUNMODE_NO          0x00
  71 #define SSH_TUNMODE_POINTOPOINT 0x01
  72 #define SSH_TUNMODE_ETHERNET    0x02
  73 #define SSH_TUNMODE_DEFAULT     SSH_TUNMODE_POINTOPOINT
  74 #define SSH_TUNMODE_YES         (SSH_TUNMODE_POINTOPOINT|SSH_TUNMODE_ETHERNET)
  75
  76 #define SSH_TUNID_ANY           0x7fffffff
  77 #define SSH_TUNID_ERR           (SSH_TUNID_ANY - 1)
  78 #define SSH_TUNID_MAX           (SSH_TUNID_ANY - 2)
  79
  80 /* Functions to extract or store big-endian words of various sizes */
  81 u_int64_t       get_u64(const void *)
  82     __attribute__((__bounded__( __minbytes__, 1, 8)));
  83 u_int32_t       get_u32(const void *)
  84     __attribute__((__bounded__( __minbytes__, 1, 4)));
  85 u_int16_t       get_u16(const void *)
  86     __attribute__((__bounded__( __minbytes__, 1, 2)));
  87 void            put_u64(void *, u_int64_t)
  88     __attribute__((__bounded__( __minbytes__, 1, 8)));
  89 void            put_u32(void *, u_int32_t)
  90     __attribute__((__bounded__( __minbytes__, 1, 4)));
  91 void            put_u16(void *, u_int16_t)
  92     __attribute__((__bounded__( __minbytes__, 1, 2)));
  93
  94 #endif /* _MISC_H */
  95