blob: bbd66ef106b6abdc67f4084e0afb056a6f0e0e7b [file] [log] [blame]
Damien Miller3f941882006-03-31 23:13:02 +11001/* $OpenBSD: misc.h,v 1.31 2006/03/30 09:58:15 djm Exp $ */
Ben Lindstrom36579d32001-01-29 07:39:26 +00002
Ben Lindstrom226cfa02001-01-22 05:34:40 +00003/*
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 */
Ben Lindstrom226cfa02001-01-22 05:34:40 +000014
Damien Miller3f941882006-03-31 23:13:02 +110015#ifndef _MISC_H
16#define _MISC_H
17
Darren Tuckere608ca22004-05-13 16:15:47 +100018/* misc.c */
19
Kevin Stevesd009ae32001-07-04 17:25:54 +000020char *chop(char *);
21char *strdelim(char **);
Damien Miller232711f2004-06-15 10:35:30 +100022int set_nonblock(int);
23int unset_nonblock(int);
Damien Miller398e1cf2002-02-05 11:52:13 +110024void set_nodelay(int);
Kevin Stevesd009ae32001-07-04 17:25:54 +000025int a2port(const char *);
Damien Millerd27b9472005-12-13 19:29:02 +110026int a2tun(const char *, int *);
Damien Millerf91ee4c2005-03-01 21:24:33 +110027char *hpdelim(char **);
Kevin Stevesd009ae32001-07-04 17:25:54 +000028char *cleanhostname(char *);
29char *colon(char *);
30long convtime(const char *);
Damien Miller5fd38c02005-05-26 12:02:14 +100031char *tilde_expand_filename(const char *, uid_t);
Darren Tucker8e2eb302005-07-14 17:07:21 +100032char *percent_expand(const char *, ...) __attribute__((__sentinel__));
Damien Miller3f941882006-03-31 23:13:02 +110033char *tohex(const void *, size_t);
Darren Tuckerce321d82005-10-03 18:11:24 +100034void sanitise_stdfd(void);
Kevin Stevesd009ae32001-07-04 17:25:54 +000035
36struct passwd *pwcopy(struct passwd *);
Ben Lindstrom226cfa02001-01-22 05:34:40 +000037
Ben Lindstrom387c4722001-05-08 20:27:25 +000038typedef struct arglist arglist;
39struct arglist {
Ben Lindstrom6328ab32002-03-22 02:54:23 +000040 char **list;
Darren Tuckerc7a6fc42004-08-13 21:18:00 +100041 u_int num;
42 u_int nalloc;
Ben Lindstrom387c4722001-05-08 20:27:25 +000043};
Damien Miller3eec6b72006-01-31 21:49:27 +110044void addargs(arglist *, char *, ...)
45 __attribute__((format(printf, 2, 3)));
46void replacearg(arglist *, u_int, char *, ...)
47 __attribute__((format(printf, 3, 4)));
48void freeargs(arglist *);
Darren Tucker06f2bd82004-05-13 16:06:46 +100049
Darren Tuckere608ca22004-05-13 16:15:47 +100050/* readpass.c */
51
52#define RP_ECHO 0x0001
53#define RP_ALLOW_STDIN 0x0002
54#define RP_ALLOW_EOF 0x0004
Damien Miller23f07702004-06-18 01:19:03 +100055#define RP_USE_ASKPASS 0x0008
Darren Tuckere608ca22004-05-13 16:15:47 +100056
57char *read_passphrase(const char *, int);
Darren Tuckerce327b62004-11-05 20:38:03 +110058int ask_permission(const char *, ...) __attribute__((format(printf, 1, 2)));
Darren Tuckerf0f90982004-12-11 13:39:50 +110059int read_keyfile_line(FILE *, const char *, char *, size_t, u_long *);
Damien Miller7b58e802005-12-13 19:33:19 +110060
61int tun_open(int, int);
62
63/* Common definitions for ssh tunnel device forwarding */
64#define SSH_TUNMODE_NO 0x00
65#define SSH_TUNMODE_POINTOPOINT 0x01
66#define SSH_TUNMODE_ETHERNET 0x02
67#define SSH_TUNMODE_DEFAULT SSH_TUNMODE_POINTOPOINT
68#define SSH_TUNMODE_YES (SSH_TUNMODE_POINTOPOINT|SSH_TUNMODE_ETHERNET)
69
70#define SSH_TUNID_ANY 0x7fffffff
71#define SSH_TUNID_ERR (SSH_TUNID_ANY - 1)
72#define SSH_TUNID_MAX (SSH_TUNID_ANY - 2)
Damien Miller3f941882006-03-31 23:13:02 +110073
74/* Functions to extract or store big-endian words of various sizes */
75u_int64_t get_u64(const void *)
76 __attribute__((__bounded__( __minbytes__, 1, 8)));
77u_int32_t get_u32(const void *)
78 __attribute__((__bounded__( __minbytes__, 1, 4)));
79u_int16_t get_u16(const void *)
80 __attribute__((__bounded__( __minbytes__, 1, 2)));
81void put_u64(void *, u_int64_t)
82 __attribute__((__bounded__( __minbytes__, 1, 8)));
83void put_u32(void *, u_int32_t)
84 __attribute__((__bounded__( __minbytes__, 1, 4)));
85void put_u16(void *, u_int16_t)
86 __attribute__((__bounded__( __minbytes__, 1, 2)));
87
88#endif /* _MISC_H */
89