usr.sbin/pw/pwupd.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (C) 1996
   5  *      David L. Nugent.  All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY DAVID L. NUGENT AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL DAVID L. NUGENT OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  *
  28  * $FreeBSD$
  29  */
  30
  31 #ifndef _PWUPD_H_
  32 #define _PWUPD_H_
  33
  34 #include <sys/cdefs.h>
  35 #include <sys/param.h>
  36 #include <sys/types.h>
  37
  38 #include <pwd.h>
  39 #include <grp.h>
  40 #include <stdbool.h>
  41 #include <stringlist.h>
  42
  43 struct pwf {
  44         int                 _altdir;
  45         void              (*_setpwent)(void);
  46         void              (*_endpwent)(void);
  47         struct passwd * (*_getpwent)(void);
  48         struct passwd   * (*_getpwuid)(uid_t uid);
  49         struct passwd   * (*_getpwnam)(const char * nam);
  50         void              (*_setgrent)(void);
  51         void              (*_endgrent)(void);
  52         struct group  * (*_getgrent)(void);
  53         struct group  * (*_getgrgid)(gid_t gid);
  54         struct group  * (*_getgrnam)(const char * nam);
  55 };
  56
  57 struct userconf {
  58         int             default_password;       /* Default password for new users? */
  59         int             reuse_uids;             /* Reuse uids? */
  60         int             reuse_gids;             /* Reuse gids? */
  61         char            *nispasswd;             /* Path to NIS version of the passwd file */
  62         char            *dotdir;                /* Where to obtain skeleton files */
  63         char            *newmail;               /* Mail to send to new accounts */
  64         char            *logfile;               /* Where to log changes */
  65         char            *home;                  /* Where to create home directory */
  66         mode_t          homemode;               /* Home directory permissions */
  67         char            *shelldir;              /* Where shells are located */
  68         char            **shells;               /* List of shells */
  69         char            *shell_default;         /* Default shell */
  70         char            *default_group;         /* Default group number */
  71         StringList      *groups;                /* Default (additional) groups */
  72         char            *default_class;         /* Default user class */
  73         uid_t           min_uid, max_uid;       /* Allowed range of uids */
  74         gid_t           min_gid, max_gid;       /* Allowed range of gids */
  75         time_t          expire_days;            /* Days to expiry */
  76         time_t          password_days;          /* Days to password expiry */
  77 };
  78
  79 struct pwconf {
  80         char             rootdir[MAXPATHLEN];
  81         char             etcpath[MAXPATHLEN];
  82         int              fd;
  83         int              rootfd;
  84         bool             checkduplicate;
  85 };
  86
  87 extern struct pwf PWF;
  88 extern struct pwf VPWF;
  89 extern struct pwconf conf;
  90
  91 #define SETPWENT()      PWF._setpwent()
  92 #define ENDPWENT()      PWF._endpwent()
  93 #define GETPWENT()      PWF._getpwent()
  94 #define GETPWUID(uid)   PWF._getpwuid(uid)
  95 #define GETPWNAM(nam)   PWF._getpwnam(nam)
  96
  97 #define SETGRENT()      PWF._setgrent()
  98 #define ENDGRENT()      PWF._endgrent()
  99 #define GETGRENT()      PWF._getgrent()
 100 #define GETGRGID(gid)   PWF._getgrgid(gid)
 101 #define GETGRNAM(nam)   PWF._getgrnam(nam)
 102
 103 #define PWF_REGULAR 0
 104 #define PWF_ALT 1
 105 #define PWF_ROOTDIR 2
 106
 107 #define PWALTDIR()      PWF._altdir
 108 #ifndef _PATH_PWD
 109 #define _PATH_PWD       "/etc"
 110 #endif
 111 #ifndef _GROUP
 112 #define _GROUP          "group"
 113 #endif
 114 #ifndef _MASTERPASSWD
 115 #define _MASTERPASSWD   "master.passwd"
 116 #endif
 117
 118 __BEGIN_DECLS
 119 int addpwent(struct passwd * pwd);
 120 int delpwent(struct passwd * pwd);
 121 int chgpwent(char const * login, struct passwd * pwd);
 122
 123 char * getpwpath(char const * file);
 124
 125 int addgrent(struct group * grp);
 126 int delgrent(struct group * grp);
 127 int chggrent(char const * name, struct group * grp);
 128
 129 char * getgrpath(const char *file);
 130
 131 void vsetpwent(void);
 132 void vendpwent(void);
 133 struct passwd * vgetpwent(void);
 134 struct passwd * vgetpwuid(uid_t uid);
 135 struct passwd * vgetpwnam(const char * nam);
 136
 137 struct group * vgetgrent(void);
 138 struct group * vgetgrgid(gid_t gid);
 139 struct group * vgetgrnam(const char * nam);
 140 void           vsetgrent(void);
 141 void           vendgrent(void);
 142
 143 void copymkdir(int rootfd, char const * dir, int skelfd, mode_t mode, uid_t uid,
 144     gid_t gid, int flags);
 145 void rm_r(int rootfd, char const * dir, uid_t uid);
 146 __END_DECLS
 147
 148 #endif                          /* !_PWUPD_H */