[openssh.git] / misc.c

/*
 * Copyright (c) 2000 Markus Friedl.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#include "includes.h"
RCSID("$OpenBSD: misc.c,v 1.20 2002/12/13 10:03:15 markus Exp $");

#include "misc.h"
#include "log.h"
#include "xmalloc.h"

/* remove newline at end of string */
char *
chop(char *s)
{
	char *t = s;
	while (*t) {
		if (*t == '\n' || *t == '\r') {
			*t = '\0';
			return s;
		}
		t++;
	}
	return s;

}

/* set/unset filedescriptor to non-blocking */
void
set_nonblock(int fd)
{
	int val;

	val = fcntl(fd, F_GETFL, 0);
	if (val < 0) {
		error("fcntl(%d, F_GETFL, 0): %s", fd, strerror(errno));
		return;
	}
	if (val & O_NONBLOCK) {
		debug2("fd %d is O_NONBLOCK", fd);
		return;
	}
	debug("fd %d setting O_NONBLOCK", fd);
	val |= O_NONBLOCK;
	if (fcntl(fd, F_SETFL, val) == -1)
		debug("fcntl(%d, F_SETFL, O_NONBLOCK): %s",
		    fd, strerror(errno));
}

void
unset_nonblock(int fd)
{
	int val;

	val = fcntl(fd, F_GETFL, 0);
	if (val < 0) {
		error("fcntl(%d, F_GETFL, 0): %s", fd, strerror(errno));
		return;
	}
	if (!(val & O_NONBLOCK)) {
		debug2("fd %d is not O_NONBLOCK", fd);
		return;
	}
	debug("fd %d clearing O_NONBLOCK", fd);
	val &= ~O_NONBLOCK;
	if (fcntl(fd, F_SETFL, val) == -1)
		debug("fcntl(%d, F_SETFL, O_NONBLOCK): %s",
		    fd, strerror(errno));
}

/* disable nagle on socket */
void
set_nodelay(int fd)
{
	int opt;
	socklen_t optlen;

	optlen = sizeof opt;
	if (getsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &opt, &optlen) == -1) {
		error("getsockopt TCP_NODELAY: %.100s", strerror(errno));
		return;
	}
	if (opt == 1) {
		debug2("fd %d is TCP_NODELAY", fd);
		return;
	}
	opt = 1;
	debug2("fd %d setting TCP_NODELAY", fd);
	if (setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &opt, sizeof opt) == -1)
		error("setsockopt TCP_NODELAY: %.100s", strerror(errno));
}

/* Characters considered whitespace in strsep calls. */
#define WHITESPACE " \t\r\n"

/* return next token in configuration line */
char *
strdelim(char **s)
{
	char *old;
	int wspace = 0;

	if (*s == NULL)
		return NULL;

	old = *s;

	*s = strpbrk(*s, WHITESPACE "=");
	if (*s == NULL)
		return (old);

	/* Allow only one '=' to be skipped */
	if (*s[0] == '=')
		wspace = 1;
	*s[0] = '\0';

	*s += strspn(*s + 1, WHITESPACE) + 1;
	if (*s[0] == '=' && !wspace)
		*s += strspn(*s + 1, WHITESPACE) + 1;

	return (old);
}

struct passwd *
pwcopy(struct passwd *pw)
{
	struct passwd *copy = xmalloc(sizeof(*copy));

	memset(copy, 0, sizeof(*copy));
	copy->pw_name = xstrdup(pw->pw_name);
	copy->pw_passwd = xstrdup(pw->pw_passwd);
	copy->pw_gecos = xstrdup(pw->pw_gecos);
	copy->pw_uid = pw->pw_uid;
	copy->pw_gid = pw->pw_gid;
#ifdef HAVE_PW_EXPIRE_IN_PASSWD
	copy->pw_expire = pw->pw_expire;
#endif
#ifdef HAVE_PW_CHANGE_IN_PASSWD
	copy->pw_change = pw->pw_change;
#endif
#ifdef HAVE_PW_CLASS_IN_PASSWD
	copy->pw_class = xstrdup(pw->pw_class);
#endif
	copy->pw_dir = xstrdup(pw->pw_dir);
	copy->pw_shell = xstrdup(pw->pw_shell);
	return copy;
}

/*
 * Convert ASCII string to TCP/IP port number.
 * Port must be >0 and <=65535.
 * Return 0 if invalid.
 */
int
a2port(const char *s)
{
	long port;
	char *endp;

	errno = 0;
	port = strtol(s, &endp, 0);
	if (s == endp || *endp != '\0' ||
	    (errno == ERANGE && (port == LONG_MIN || port == LONG_MAX)) ||
	    port <= 0 || port > 65535)
		return 0;

	return port;
}

#define SECONDS		1
#define MINUTES		(SECONDS * 60)
#define HOURS		(MINUTES * 60)
#define DAYS		(HOURS * 24)
#define WEEKS		(DAYS * 7)

/*
 * Convert a time string into seconds; format is
 * a sequence of:
 *      time[qualifier]
 *
 * Valid time qualifiers are:
 *      <none>  seconds
 *      s|S     seconds
 *      m|M     minutes
 *      h|H     hours
 *      d|D     days
 *      w|W     weeks
 *
 * Examples:
 *      90m     90 minutes
 *      1h30m   90 minutes
 *      2d      2 days
 *      1w      1 week
 *
 * Return -1 if time string is invalid.
 */
long
convtime(const char *s)
{
	long total, secs;
	const char *p;
	char *endp;

	errno = 0;
	total = 0;
	p = s;

	if (p == NULL || *p == '\0')
		return -1;

	while (*p) {
		secs = strtol(p, &endp, 10);
		if (p == endp ||
		    (errno == ERANGE && (secs == LONG_MIN || secs == LONG_MAX)) ||
		    secs < 0)
			return -1;

		switch (*endp++) {
		case '\0':
			endp--;
		case 's':
		case 'S':
			break;
		case 'm':
		case 'M':
			secs *= MINUTES;
			break;
		case 'h':
		case 'H':
			secs *= HOURS;
			break;
		case 'd':
		case 'D':
			secs *= DAYS;
			break;
		case 'w':
		case 'W':
			secs *= WEEKS;
			break;
		default:
			return -1;
		}
		total += secs;
		if (total < 0)
			return -1;
		p = endp;
	}

	return total;
}

char *
cleanhostname(char *host)
{
	if (*host == '[' && host[strlen(host) - 1] == ']') {
		host[strlen(host) - 1] = '\0';
		return (host + 1);
	} else
		return host;
}

char *
colon(char *cp)
{
	int flag = 0;

	if (*cp == ':')		/* Leading colon is part of file name. */
		return (0);
	if (*cp == '[')
		flag = 1;

	for (; *cp; ++cp) {
		if (*cp == '@' && *(cp+1) == '[')
			flag = 1;
		if (*cp == ']' && *(cp+1) == ':' && flag)
			return (cp+1);
		if (*cp == ':' && !flag)
			return (cp);
		if (*cp == '/')
			return (0);
	}
	return (0);
}

/* function to assist building execv() arguments */
void
addargs(arglist *args, char *fmt, ...)
{
	va_list ap;
	char buf[1024];

	va_start(ap, fmt);
	vsnprintf(buf, sizeof(buf), fmt, ap);
	va_end(ap);

	if (args->list == NULL) {
		args->nalloc = 32;
		args->num = 0;
	} else if (args->num+2 >= args->nalloc)
		args->nalloc *= 2;

	args->list = xrealloc(args->list, args->nalloc * sizeof(char *));
	args->list[args->num++] = xstrdup(buf);
	args->list[args->num] = NULL;
}

mysig_t
mysignal(int sig, mysig_t act)
{
#ifdef HAVE_SIGACTION
	struct sigaction sa, osa;

	if (sigaction(sig, NULL, &osa) == -1)
		return (mysig_t) -1;
	if (osa.sa_handler != act) {
		memset(&sa, 0, sizeof(sa));
		sigemptyset(&sa.sa_mask);
		sa.sa_flags = 0;
#if defined(SA_INTERRUPT)
		if (sig == SIGALRM)
			sa.sa_flags |= SA_INTERRUPT;
#endif
		sa.sa_handler = act;
		if (sigaction(sig, &sa, NULL) == -1)
			return (mysig_t) -1;
	}
	return (osa.sa_handler);
#else
	return (signal(sig, act));
#endif
}
Commit	Line	Data
bcbf86ec	1	/*
	2	* Copyright (c) 2000 Markus Friedl. All rights reserved.
	3	*
	4	* Redistribution and use in source and binary forms, with or without
	5	* modification, are permitted provided that the following conditions
	6	* are met:
	7	* 1. Redistributions of source code must retain the above copyright
	8	* notice, this list of conditions and the following disclaimer.
	9	* 2. Redistributions in binary form must reproduce the above copyright
	10	* notice, this list of conditions and the following disclaimer in the
	11	* documentation and/or other materials provided with the distribution.
	12	*
	13	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
	14	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
	15	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
	16	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
	17	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
	18	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
	19	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
	20	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	21	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
	22	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	23	*/
	24
6d24277f	25	#include "includes.h"
6226a8f8	26	RCSID("$OpenBSD: misc.c,v 1.20 2002/12/13 10:03:15 markus Exp $");
6d24277f	27
1aa00dcb	28	#include "misc.h"
42f11eb2	29	#include "log.h"
4ab21f86	30	#include "xmalloc.h"
6d24277f	31
255cabd9	32	/* remove newline at end of string */
6d24277f	33	char *
	34	chop(char *s)
	35	{
	36	char *t = s;
	37	while (*t) {
6aacefa7	38	if (t == '\n' \|\| t == '\r') {
6d24277f	39	*t = '\0';
	40	return s;
	41	}
	42	t++;
	43	}
	44	return s;
	45
	46	}
	47
255cabd9	48	/* set/unset filedescriptor to non-blocking */
6d24277f	49	void
	50	set_nonblock(int fd)
	51	{
	52	int val;
89aa792b	53
6d24277f	54	val = fcntl(fd, F_GETFL, 0);
	55	if (val < 0) {
	56	error("fcntl(%d, F_GETFL, 0): %s", fd, strerror(errno));
	57	return;
	58	}
a22aff1f	59	if (val & O_NONBLOCK) {
89aa792b	60	debug2("fd %d is O_NONBLOCK", fd);
6d24277f	61	return;
a22aff1f	62	}
6d24277f	63	debug("fd %d setting O_NONBLOCK", fd);
	64	val \|= O_NONBLOCK;
	65	if (fcntl(fd, F_SETFL, val) == -1)
c92ec40b	66	debug("fcntl(%d, F_SETFL, O_NONBLOCK): %s",
c92ec40b	67	fd, strerror(errno));
6d24277f	68	}
6d24277f	69
89aa792b	70	void
	71	unset_nonblock(int fd)
	72	{
	73	int val;
	74
	75	val = fcntl(fd, F_GETFL, 0);
	76	if (val < 0) {
	77	error("fcntl(%d, F_GETFL, 0): %s", fd, strerror(errno));
	78	return;
	79	}
	80	if (!(val & O_NONBLOCK)) {
	81	debug2("fd %d is not O_NONBLOCK", fd);
	82	return;
	83	}
e04e7a19	84	debug("fd %d clearing O_NONBLOCK", fd);
89aa792b	85	val &= ~O_NONBLOCK;
89aa792b	86	if (fcntl(fd, F_SETFL, val) == -1)
c92ec40b	87	debug("fcntl(%d, F_SETFL, O_NONBLOCK): %s",
c92ec40b	88	fd, strerror(errno));
89aa792b	89	}
89aa792b	90
bcc0381e	91	/* disable nagle on socket */
	92	void
	93	set_nodelay(int fd)
	94	{
3c05447a	95	int opt;
3c05447a	96	socklen_t optlen;
bcc0381e	97
811a6342	98	optlen = sizeof opt;
	99	if (getsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &opt, &optlen) == -1) {
	100	error("getsockopt TCP_NODELAY: %.100s", strerror(errno));
	101	return;
	102	}
	103	if (opt == 1) {
	104	debug2("fd %d is TCP_NODELAY", fd);
	105	return;
	106	}
	107	opt = 1;
6226a8f8	108	debug2("fd %d setting TCP_NODELAY", fd);
811a6342	109	if (setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &opt, sizeof opt) == -1)
bcc0381e	110	error("setsockopt TCP_NODELAY: %.100s", strerror(errno));
	111	}
	112
6d24277f	113	/* Characters considered whitespace in strsep calls. */
	114	#define WHITESPACE " \t\r\n"
	115
255cabd9	116	/* return next token in configuration line */
6d24277f	117	char *
	118	strdelim(char **s)
	119	{
	120	char *old;
	121	int wspace = 0;
	122
	123	if (*s == NULL)
	124	return NULL;
	125
	126	old = *s;
	127
	128	s = strpbrk(s, WHITESPACE "=");
	129	if (*s == NULL)
	130	return (old);
	131
	132	/* Allow only one '=' to be skipped */
	133	if (*s[0] == '=')
	134	wspace = 1;
	135	*s[0] = '\0';
	136
	137	s += strspn(s + 1, WHITESPACE) + 1;
	138	if (*s[0] == '=' && !wspace)
	139	s += strspn(s + 1, WHITESPACE) + 1;
	140
	141	return (old);
	142	}
1aa00dcb	143
3b1a83df	144	struct passwd *
	145	pwcopy(struct passwd *pw)
	146	{
	147	struct passwd copy = xmalloc(sizeof(copy));
5649fbbe	148
3b1a83df	149	memset(copy, 0, sizeof(*copy));
	150	copy->pw_name = xstrdup(pw->pw_name);
	151	copy->pw_passwd = xstrdup(pw->pw_passwd);
5649fbbe	152	copy->pw_gecos = xstrdup(pw->pw_gecos);
3b1a83df	153	copy->pw_uid = pw->pw_uid;
3b1a83df	154	copy->pw_gid = pw->pw_gid;
7751d4eb	155	#ifdef HAVE_PW_EXPIRE_IN_PASSWD
c4d49b85	156	copy->pw_expire = pw->pw_expire;
7751d4eb	157	#endif
7751d4eb	158	#ifdef HAVE_PW_CHANGE_IN_PASSWD
c4d49b85	159	copy->pw_change = pw->pw_change;
7751d4eb	160	#endif
2605addd	161	#ifdef HAVE_PW_CLASS_IN_PASSWD
3b1a83df	162	copy->pw_class = xstrdup(pw->pw_class);
2605addd	163	#endif
3b1a83df	164	copy->pw_dir = xstrdup(pw->pw_dir);
	165	copy->pw_shell = xstrdup(pw->pw_shell);
	166	return copy;
	167	}
	168
255cabd9	169	/*
	170	* Convert ASCII string to TCP/IP port number.
	171	* Port must be >0 and <=65535.
	172	* Return 0 if invalid.
	173	*/
	174	int
	175	a2port(const char *s)
2d2a2c65	176	{
	177	long port;
	178	char *endp;
	179
	180	errno = 0;
	181	port = strtol(s, &endp, 0);
	182	if (s == endp \|\| *endp != '\0' \|\|
	183	(errno == ERANGE && (port == LONG_MIN \|\| port == LONG_MAX)) \|\|
	184	port <= 0 \|\| port > 65535)
	185	return 0;
	186
	187	return port;
	188	}
	189
e2b1fb42	190	#define SECONDS 1
	191	#define MINUTES (SECONDS * 60)
	192	#define HOURS (MINUTES * 60)
	193	#define DAYS (HOURS * 24)
	194	#define WEEKS (DAYS * 7)
	195
255cabd9	196	/*
	197	* Convert a time string into seconds; format is
	198	* a sequence of:
	199	* time[qualifier]
	200	*
	201	* Valid time qualifiers are:
	202	* <none> seconds
	203	* s\|S seconds
	204	* m\|M minutes
	205	* h\|H hours
	206	* d\|D days
	207	* w\|W weeks
	208	*
	209	* Examples:
	210	* 90m 90 minutes
	211	* 1h30m 90 minutes
	212	* 2d 2 days
	213	* 1w 1 week
	214	*
	215	* Return -1 if time string is invalid.
	216	*/
	217	long
	218	convtime(const char *s)
e2b1fb42	219	{
	220	long total, secs;
	221	const char *p;
	222	char *endp;
	223
	224	errno = 0;
	225	total = 0;
	226	p = s;
	227
	228	if (p == NULL \|\| *p == '\0')
	229	return -1;
	230
	231	while (*p) {
	232	secs = strtol(p, &endp, 10);
	233	if (p == endp \|\|
	234	(errno == ERANGE && (secs == LONG_MIN \|\| secs == LONG_MAX)) \|\|
	235	secs < 0)
	236	return -1;
	237
	238	switch (*endp++) {
	239	case '\0':
	240	endp--;
	241	case 's':
	242	case 'S':
	243	break;
	244	case 'm':
	245	case 'M':
	246	secs *= MINUTES;
	247	break;
	248	case 'h':
	249	case 'H':
	250	secs *= HOURS;
	251	break;
	252	case 'd':
	253	case 'D':
	254	secs *= DAYS;
	255	break;
	256	case 'w':
	257	case 'W':
	258	secs *= WEEKS;
	259	break;
	260	default:
	261	return -1;
	262	}
	263	total += secs;
	264	if (total < 0)
	265	return -1;
	266	p = endp;
	267	}
	268
	269	return total;
	270	}
	271
1fcde3fe	272	char *
	273	cleanhostname(char *host)
	274	{
	275	if (*host == '[' && host[strlen(host) - 1] == ']') {
	276	host[strlen(host) - 1] = '\0';
	277	return (host + 1);
	278	} else
	279	return host;
	280	}
	281
	282	char *
	283	colon(char *cp)
	284	{
	285	int flag = 0;
	286
	287	if (cp == ':') / Leading colon is part of file name. */
	288	return (0);
	289	if (*cp == '[')
	290	flag = 1;
	291
	292	for (; *cp; ++cp) {
	293	if (cp == '@' && (cp+1) == '[')
	294	flag = 1;
	295	if (cp == ']' && (cp+1) == ':' && flag)
	296	return (cp+1);
	297	if (*cp == ':' && !flag)
	298	return (cp);
	299	if (*cp == '/')
	300	return (0);
	301	}
	302	return (0);
	303	}
	304
255cabd9	305	/* function to assist building execv() arguments */
8a624ebf	306	void
	307	addargs(arglist args, char fmt, ...)
	308	{
	309	va_list ap;
	310	char buf[1024];
	311
	312	va_start(ap, fmt);
	313	vsnprintf(buf, sizeof(buf), fmt, ap);
	314	va_end(ap);
	315
	316	if (args->list == NULL) {
	317	args->nalloc = 32;
	318	args->num = 0;
184eed6a	319	} else if (args->num+2 >= args->nalloc)
8a624ebf	320	args->nalloc *= 2;
	321
	322	args->list = xrealloc(args->list, args->nalloc * sizeof(char *));
	323	args->list[args->num++] = xstrdup(buf);
	324	args->list[args->num] = NULL;
	325	}
	326
1aa00dcb	327	mysig_t
	328	mysignal(int sig, mysig_t act)
	329	{
	330	#ifdef HAVE_SIGACTION
	331	struct sigaction sa, osa;
	332
120bf679	333	if (sigaction(sig, NULL, &osa) == -1)
1aa00dcb	334	return (mysig_t) -1;
1aa00dcb	335	if (osa.sa_handler != act) {
120bf679	336	memset(&sa, 0, sizeof(sa));
1aa00dcb	337	sigemptyset(&sa.sa_mask);
1aa00dcb	338	sa.sa_flags = 0;
d54d99a3	339	#if defined(SA_INTERRUPT)
d54d99a3	340	if (sig == SIGALRM)
df538d55	341	sa.sa_flags \|= SA_INTERRUPT;
25cd3375	342	#endif
1aa00dcb	343	sa.sa_handler = act;
120bf679	344	if (sigaction(sig, &sa, NULL) == -1)
1aa00dcb	345	return (mysig_t) -1;
	346	}
	347	return (osa.sa_handler);
	348	#else
	349	return (signal(sig, act));
	350	#endif
	351	}