lib/libutil/libutil.h

   1 /*
   2  * Copyright (c) 1996  Peter Wemm <peter@FreeBSD.org>.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, is permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  * $FreeBSD$
  27  */
  28
  29 #ifndef _LIBUTIL_H_
  30 #define _LIBUTIL_H_
  31
  32 #include <sys/cdefs.h>
  33
  34 #define PROPERTY_MAX_NAME       64
  35 #define PROPERTY_MAX_VALUE      512
  36
  37 /* for properties.c */
  38 typedef struct _property {
  39         struct _property *next;
  40         char *name;
  41         char *value;
  42 } *properties;
  43
  44 /* Avoid pulling in all the include files for no need */
  45 struct termios;
  46 struct winsize;
  47 struct utmp;
  48 struct in_addr;
  49
  50 __BEGIN_DECLS
  51 int     extattr_namespace_to_string(int _attrnamespace, char **_string);
  52 int     extattr_string_to_namespace(const char *_string, int *_attrnamespace);
  53 void    login(struct utmp *_ut);
  54 int     login_tty(int _fd);
  55 int     logout(const char *_line);
  56 void    logwtmp(const char *_line, const char *_name, const char *_host);
  57 void    trimdomain(char *_fullhost, int _hostsize);
  58 int     openpty(int *_amaster, int *_aslave, char *_name,
  59                      struct termios *_termp, struct winsize *_winp);
  60 int     forkpty(int *_amaster, char *_name,
  61                      struct termios *_termp, struct winsize *_winp);
  62 const char *uu_lockerr(int _uu_lockresult);
  63 int     uu_lock(const char *_ttyname);
  64 int     uu_unlock(const char *_ttyname);
  65 int     uu_lock_txfr(const char *_ttyname, pid_t _pid);
  66 int     _secure_path(const char *_path, uid_t _uid, gid_t _gid);
  67 properties properties_read(int fd);
  68 void    properties_free(properties list);
  69 char    *property_find(properties list, const char *name);
  70 char    *auth_getval(const char *name);
  71 int     realhostname(char *host, size_t hsize, const struct in_addr *ip);
  72 struct sockaddr;
  73 int     realhostname_sa(char *host, size_t hsize, struct sockaddr *addr,
  74                              int addrlen);
  75 #ifdef _STDIO_H_        /* avoid adding new includes */
  76 char   *fparseln(FILE *, size_t *, size_t *, const char[3], int);
  77 #endif
  78 __END_DECLS
  79
  80 #define UU_LOCK_INUSE (1)
  81 #define UU_LOCK_OK (0)
  82 #define UU_LOCK_OPEN_ERR (-1)
  83 #define UU_LOCK_READ_ERR (-2)
  84 #define UU_LOCK_CREAT_ERR (-3)
  85 #define UU_LOCK_WRITE_ERR (-4)
  86 #define UU_LOCK_LINK_ERR (-5)
  87 #define UU_LOCK_TRY_ERR (-6)
  88 #define UU_LOCK_OWNER_ERR (-7)
  89
  90 /* return values from realhostname() */
  91 #define HOSTNAME_FOUND          (0)
  92 #define HOSTNAME_INCORRECTNAME  (1)
  93 #define HOSTNAME_INVALIDADDR    (2)
  94 #define HOSTNAME_INVALIDNAME    (3)
  95
  96 /* fparseln(3) */
  97 #define FPARSELN_UNESCESC       0x01
  98 #define FPARSELN_UNESCCONT      0x02
  99 #define FPARSELN_UNESCCOMM      0x04
 100 #define FPARSELN_UNESCREST      0x08
 101 #define FPARSELN_UNESCALL       0x0f
 102
 103 #endif /* !_LIBUTIL_H_ */