/*
* Copyright (c) 1996  Peter Wemm <[email protected]>.
* All rights reserved.
* Copyright (c) 2002 Networks Associates Technology, Inc.
* All rights reserved.
*
* Portions of this software were developed for the FreeBSD Project by
* ThinkSec AS and NAI Labs, the Security Research Division of Network
* Associates, Inc.  under DARPA/SPAWAR contract N66001-01-C-8035
* ("CBOSS"), as part of the DARPA CHATS research program.
*
* Redistribution and use in source and binary forms, with or without
* modification, is 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.
* 3. The name of the author may not be used to endorse or promote
*    products derived from this software without specific prior written
*    permission.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``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 OR CONTRIBUTORS 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.
*
* $FreeBSD: src/lib/libutil/libutil.h,v 1.42 2006/02/18 11:25:28 des Exp $
*/

#ifndef _LIBUTIL_H_
#define _LIBUTIL_H_

#include <unistd.h>
#define PROPERTY_MAX_NAME       64
#define PROPERTY_MAX_VALUE      512

/* for properties.c */
typedef struct _property {
       struct _property *next;
       char *name;
       char *value;
} *properties;

#ifdef _SYS_PARAM_H_
/* for pidfile.c */
struct pidfh {
       int     pf_fd;
       char    pf_path[MAXPATHLEN + 1];
       dev_t   pf_dev;
       ino_t   pf_ino;
};
#endif

/* Avoid pulling in all the include files for no need */
struct termios;
struct winsize;
struct utmp;
struct in_addr;

__BEGIN_DECLS
void    clean_environment(const char * const *_white,
           const char * const *_more_white);
int     extattr_namespace_to_string(int _attrnamespace, char **_string);
int     extattr_string_to_namespace(const char *_string, int *_attrnamespace);
void    login(struct utmp *_ut);
int     login_tty(int _fd);
int     logout(const char *_line);
void    logwtmp(const char *_line, const char *_name, const char *_host);
void    trimdomain(char *_fullhost, int _hostsize);
int     openpty(int *_amaster, int *_aslave, char *_name,
                    struct termios *_termp, struct winsize *_winp);
int     forkpty(int *_amaster, char *_name,
                    struct termios *_termp, struct winsize *_winp);
int     humanize_number(char *_buf, size_t _len, int64_t _number,
           const char *_suffix, int _scale, int _flags);
const char *uu_lockerr(int _uu_lockresult);
int     uu_lock(const char *_ttyname);
int     uu_unlock(const char *_ttyname);
int     uu_lock_txfr(const char *_ttyname, pid_t _pid);
int     _secure_path(const char *_path, uid_t _uid, gid_t _gid);
properties properties_read(int fd);
void    properties_free(properties list);
char    *property_find(properties list, const char *name);
char    *auth_getval(const char *name);
int     realhostname(char *host, size_t hsize, const struct in_addr *ip);
struct sockaddr;
int     realhostname_sa(char *host, size_t hsize, struct sockaddr *addr,
                            int addrlen);

int     kld_isloaded(const char *name);
int     kld_load(const char *name);

#ifdef _STDIO_H_        /* avoid adding new includes */
char   *fparseln(FILE *, size_t *, size_t *, const char[3], int);
#endif

#ifdef _PWD_H_
int     pw_copy(int _ffd, int _tfd, const struct passwd *_pw, struct passwd *_old_pw);
struct passwd *pw_dup(const struct passwd *_pw);
int     pw_edit(int _notsetuid);
int     pw_equal(const struct passwd *_pw1, const struct passwd *_pw2);
void    pw_fini(void);
int     pw_init(const char *_dir, const char *_master);
char    *pw_make(const struct passwd *_pw);
int     pw_mkdb(const char *_user);
int     pw_lock(void);
struct passwd *pw_scan(const char *_line, int _flags);
const char *pw_tempname(void);
int     pw_tmp(int _mfd);
#endif

#ifdef _SYS_PARAM_H_
struct pidfh *pidfile_open(const char *path, mode_t mode, pid_t *pidptr);
int pidfile_write(struct pidfh *pfh);
int pidfile_close(struct pidfh *pfh);
int pidfile_remove(struct pidfh *pfh);
#endif

__END_DECLS

#define UU_LOCK_INUSE (1)
#define UU_LOCK_OK (0)
#define UU_LOCK_OPEN_ERR (-1)
#define UU_LOCK_READ_ERR (-2)
#define UU_LOCK_CREAT_ERR (-3)
#define UU_LOCK_WRITE_ERR (-4)
#define UU_LOCK_LINK_ERR (-5)
#define UU_LOCK_TRY_ERR (-6)
#define UU_LOCK_OWNER_ERR (-7)

/* return values from realhostname() */
#define HOSTNAME_FOUND          (0)
#define HOSTNAME_INCORRECTNAME  (1)
#define HOSTNAME_INVALIDADDR    (2)
#define HOSTNAME_INVALIDNAME    (3)

/* fparseln(3) */
#define FPARSELN_UNESCESC       0x01
#define FPARSELN_UNESCCONT      0x02
#define FPARSELN_UNESCCOMM      0x04
#define FPARSELN_UNESCREST      0x08
#define FPARSELN_UNESCALL       0x0f

/* pw_scan() */
#define PWSCAN_MASTER           0x01
#define PWSCAN_WARN             0x02

/* humanize_number(3) */
#define HN_DECIMAL              0x01
#define HN_NOSPACE              0x02
#define HN_B                    0x04
#define HN_DIVISOR_1000         0x08

#define HN_GETSCALE             0x10
#define HN_AUTOSCALE            0x20

#endif /* !_LIBUTIL_H_ */