chiark - git - mdw - tripe/blob - common/util.h

   1 /* -*-c-*-
   2  *
   3  * Utilities for the client and the server
   4  *
   5  * (c) 2001 Straylight/Edgeware
   6  */
   7
   8 /*----- Licensing notice --------------------------------------------------*
   9  *
  10  * This file is part of Trivial IP Encryption (TrIPE).
  11  *
  12  * TrIPE is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 2 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * TrIPE is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with TrIPE; if not, write to the Free Software Foundation,
  24  * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  25  */
  26
  27 #ifndef UTIL_H
  28 #define UTIL_H
  29
  30 #ifndef CONFIG_H
  31 #  include "config.h"
  32 #endif
  33
  34 #include <sys/types.h>
  35
  36 #include <mLib/macros.h>
  37
  38 #ifdef __cplusplus
  39   extern "C" {
  40 #endif
  41
  42 /*----- Functions provided ------------------------------------------------*/
  43
  44 /* --- @u_quotify@ --- *
  45  *
  46  * Arguments:   @dstr *d@ = where to write the answer
  47  *              @const char *p@ = string to quotify
  48  *
  49  * Returns:     ---
  50  *
  51  * Use:         Quotes the given string if necessary, according to our
  52  *              quoting rules.
  53  */
  54
  55 extern void u_quotify(dstr */*d*/, const char */*p*/);
  56
  57 /* --- @u_getuser@ --- *
  58  *
  59  * Arguments:   @const char *name@ = user name or id requested
  60  *              @gid_t *gg@ = where to store corresponding gid
  61  *
  62  * Returns:     Corresponding uid.
  63  *
  64  * Use:         Resolves a user name into a uid.  Dies on failure; suitable
  65  *              for use in argument parsing.
  66  */
  67
  68 extern uid_t u_getuser(const char */*name*/, gid_t */*gg*/);
  69
  70 /* --- @u_getgroup@ --- *
  71  *
  72  * Arguments:   @const char *name@ = user name or id requested
  73  *
  74  * Returns:     Corresponding gid.
  75  *
  76  * Use:         Resolves a group name into a gid.  Dies on failure; suitable
  77  *              for use in argument parsing.
  78  */
  79
  80 extern gid_t u_getgroup(const char */*name*/);
  81
  82 /* --- @u_setugid@ --- *
  83  *
  84  * Arguments:   @uid_t u@ = user to set
  85  *              @gid_t g@ = group to set
  86  *
  87  * Returns:     ---
  88  *
  89  * Use:         Sets user and group to the given values; aborts on failure.
  90  */
  91
  92 extern void u_setugid(uid_t /*u*/, gid_t /*g*/);
  93
  94 /*----- That's all, folks -------------------------------------------------*/
  95
  96 #ifdef __cplusplus
  97   }
  98 #endif
  99
 100 #endif