lib/privs.h

   1 /*
   2  * Zebra privileges header.
   3  *
   4  * Copyright (C) 2003 Paul Jakma.
   5  *
   6  * This file is part of GNU Zebra.
   7  *
   8  * GNU Zebra is free software; you can redistribute it and/or modify it
   9  * under the terms of the GNU General Public License as published by the
  10  * Free Software Foundation; either version 2, or (at your option) any
  11  * later version.
  12  *
  13  * GNU Zebra is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with GNU Zebra; see the file COPYING.  If not, write to the Free
  20  * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  21  * 02111-1307, USA.
  22  */
  23
  24 #ifndef _ZEBRA_PRIVS_H
  25 #define _ZEBRA_PRIVS_H
  26
  27 /* list of zebra capabilities */
  28 typedef enum {
  29         ZCAP_SETID,
  30         ZCAP_BIND,
  31         ZCAP_NET_ADMIN,
  32         ZCAP_SYS_ADMIN,
  33         ZCAP_NET_RAW,
  34         ZCAP_CHROOT,
  35         ZCAP_NICE,
  36         ZCAP_PTRACE,
  37         ZCAP_DAC_OVERRIDE,
  38         ZCAP_READ_SEARCH,
  39         ZCAP_FOWNER,
  40         ZCAP_MAX
  41 } zebra_capabilities_t;
  42
  43 typedef enum {
  44         ZPRIVS_LOWERED,
  45         ZPRIVS_RAISED,
  46         ZPRIVS_UNKNOWN,
  47 } zebra_privs_current_t;
  48
  49 typedef enum {
  50         ZPRIVS_RAISE,
  51         ZPRIVS_LOWER,
  52 } zebra_privs_ops_t;
  53
  54 struct zebra_privs_t {
  55         zebra_capabilities_t *caps_p; /* caps required for operation */
  56         zebra_capabilities_t *caps_i; /* caps to allow inheritance of */
  57         int cap_num_p;                /* number of caps in arrays */
  58         int cap_num_i;
  59         const char *user; /* user and group to run as */
  60         const char *group;
  61         const char *vty_group; /* group to chown vty socket to */
  62         /* methods */
  63         int (*change)(zebra_privs_ops_t); /* change privileges, 0 on success */
  64         zebra_privs_current_t (*current_state)(
  65                 void); /* current privilege state */
  66 };
  67
  68 struct zprivs_ids_t {
  69         /* -1 is undefined */
  70         uid_t uid_priv;   /* privileged uid */
  71         uid_t uid_normal; /* normal uid */
  72         gid_t gid_priv;   /* privileged uid */
  73         gid_t gid_normal; /* normal uid */
  74         gid_t gid_vty;    /* vty gid */
  75 };
  76
  77 /* initialise zebra privileges */
  78 extern void zprivs_init(struct zebra_privs_t *zprivs);
  79 /* drop all and terminate privileges */
  80 extern void zprivs_terminate(struct zebra_privs_t *);
  81 /* query for runtime uid's and gid's, eg vty needs this */
  82 extern void zprivs_get_ids(struct zprivs_ids_t *);
  83
  84 #endif /* _ZEBRA_PRIVS_H */