blob: be05e806b16703a11fe7284996f34f69cb20583f [file] [log] [blame]
Darren Tucker4abde772007-12-29 02:43:51 +11001/* $OpenBSD: misc.h,v 1.37 2007/12/27 14:22:08 dtucker 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 *);
Darren Tuckerda345532006-07-10 23:04:19 +100027char *put_host_port(const char *, u_short);
Damien Millerf91ee4c2005-03-01 21:24:33 +110028char *hpdelim(char **);
Kevin Stevesd009ae32001-07-04 17:25:54 +000029char *cleanhostname(char *);
30char *colon(char *);
31long convtime(const char *);
Damien Miller5fd38c02005-05-26 12:02:14 +100032char *tilde_expand_filename(const char *, uid_t);
Darren Tucker8e2eb302005-07-14 17:07:21 +100033char *percent_expand(const char *, ...) __attribute__((__sentinel__));
Damien Miller3f941882006-03-31 23:13:02 +110034char *tohex(const void *, size_t);
Darren Tuckerce321d82005-10-03 18:11:24 +100035void sanitise_stdfd(void);
Kevin Stevesd009ae32001-07-04 17:25:54 +000036
37struct passwd *pwcopy(struct passwd *);
Darren Tucker4abde772007-12-29 02:43:51 +110038const char *ssh_gai_strerror(int);
Ben Lindstrom226cfa02001-01-22 05:34:40 +000039
Ben Lindstrom387c4722001-05-08 20:27:25 +000040typedef struct arglist arglist;
41struct arglist {
Ben Lindstrom6328ab32002-03-22 02:54:23 +000042 char **list;
Darren Tuckerc7a6fc42004-08-13 21:18:00 +100043 u_int num;
44 u_int nalloc;
Ben Lindstrom387c4722001-05-08 20:27:25 +000045};
Damien Miller3eec6b72006-01-31 21:49:27 +110046void addargs(arglist *, char *, ...)
47 __attribute__((format(printf, 2, 3)));
48void replacearg(arglist *, u_int, char *, ...)
49 __attribute__((format(printf, 3, 4)));
50void freeargs(arglist *);
Darren Tucker06f2bd82004-05-13 16:06:46 +100051
Damien Miller7b58e802005-12-13 19:33:19 +110052int tun_open(int, int);
53
54/* Common definitions for ssh tunnel device forwarding */
55#define SSH_TUNMODE_NO 0x00
56#define SSH_TUNMODE_POINTOPOINT 0x01
57#define SSH_TUNMODE_ETHERNET 0x02
58#define SSH_TUNMODE_DEFAULT SSH_TUNMODE_POINTOPOINT
59#define SSH_TUNMODE_YES (SSH_TUNMODE_POINTOPOINT|SSH_TUNMODE_ETHERNET)
60
61#define SSH_TUNID_ANY 0x7fffffff
62#define SSH_TUNID_ERR (SSH_TUNID_ANY - 1)
63#define SSH_TUNID_MAX (SSH_TUNID_ANY - 2)
Damien Miller3f941882006-03-31 23:13:02 +110064
65/* Functions to extract or store big-endian words of various sizes */
66u_int64_t get_u64(const void *)
67 __attribute__((__bounded__( __minbytes__, 1, 8)));
68u_int32_t get_u32(const void *)
69 __attribute__((__bounded__( __minbytes__, 1, 4)));
70u_int16_t get_u16(const void *)
71 __attribute__((__bounded__( __minbytes__, 1, 2)));
72void put_u64(void *, u_int64_t)
73 __attribute__((__bounded__( __minbytes__, 1, 8)));
74void put_u32(void *, u_int32_t)
75 __attribute__((__bounded__( __minbytes__, 1, 4)));
76void put_u16(void *, u_int16_t)
77 __attribute__((__bounded__( __minbytes__, 1, 2)));
78
Damien Miller3f941882006-03-31 23:13:02 +110079
Damien Millerbdf00ca2006-08-19 00:33:05 +100080/* readpass.c */
81
82#define RP_ECHO 0x0001
83#define RP_ALLOW_STDIN 0x0002
84#define RP_ALLOW_EOF 0x0004
85#define RP_USE_ASKPASS 0x0008
86
87char *read_passphrase(const char *, int);
88int ask_permission(const char *, ...) __attribute__((format(printf, 1, 2)));
89int read_keyfile_line(FILE *, const char *, char *, size_t, u_long *);
90
91#endif /* _MISC_H */