X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/tripe/blobdiff_plain/0ed0735f38c78e11cdf1c2b095ba754a92d2d201..ec9b8aed722484df3578cef7a9058aff2ed20852:/common/util.h diff --git a/common/util.h b/common/util.h index 0c135480..acdc0f6e 100644 --- a/common/util.h +++ b/common/util.h @@ -1,13 +1,11 @@ /* -*-c-*- - * - * $Id: util.h,v 1.3 2004/04/08 01:36:17 mdw Exp $ * * Utilities for the client and the server * * (c) 2001 Straylight/Edgeware */ -/*----- Licensing notice --------------------------------------------------* +/*----- Licensing notice --------------------------------------------------* * * This file is part of Trivial IP Encryption (TrIPE). * @@ -15,12 +13,12 @@ * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. - * + * * TrIPE is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. - * + * * You should have received a copy of the GNU General Public License * along with TrIPE; if not, write to the Free Software Foundation, * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. @@ -29,10 +27,28 @@ #ifndef UTIL_H #define UTIL_H +#ifndef CONFIG_H +# include "config.h" +#endif + +#include + #ifdef __cplusplus extern "C" { #endif +/*----- Macros ------------------------------------------------------------*/ + +/* --- @IGNORE@ --- * + * + * Arguments: @expr@ = an expression whose value is to be ignored + * + * Use: Ignores the value of an expression, even if compilers want + * us not to. + */ + +#define IGNORE(expr) do { if (expr) ; } while (0) + /*----- Functions provided ------------------------------------------------*/ /* --- @u_quotify@ --- * @@ -48,28 +64,42 @@ extern void u_quotify(dstr */*d*/, const char */*p*/); -/* --- @u_detach@ --- * +/* --- @u_getuser@ --- * * - * Arguments: --- + * Arguments: @const char *name@ = user name or id requested + * @gid_t *gg@ = where to store corresponding gid * - * Returns: --- + * Returns: Corresponding uid. + * + * Use: Resolves a user name into a uid. Dies on failure; suitable + * for use in argument parsing. + */ + +extern uid_t u_getuser(const char */*name*/, gid_t */*gg*/); + +/* --- @u_getgroup@ --- * + * + * Arguments: @const char *name@ = user name or id requested * - * Use: Detaches from the current terminal and ensures it can never - * acquire a new one. Calls @fork@. + * Returns: Corresponding gid. + * + * Use: Resolves a group name into a gid. Dies on failure; suitable + * for use in argument parsing. */ -extern void u_detach(void); +extern gid_t u_getgroup(const char */*name*/); -/* --- @u_daemon@ --- * +/* --- @u_setugid@ --- * * - * Arguments: --- + * Arguments: @uid_t u@ = user to set + * @gid_t g@ = group to set * - * Returns: Zero if OK, nonzero on failure. + * Returns: --- * - * Use: Becomes a daemon. + * Use: Sets user and group to the given values; aborts on failure. */ -extern int u_daemon(void); +extern void u_setugid(uid_t /*u*/, gid_t /*g*/); /*----- That's all, folks -------------------------------------------------*/