wsutil/privileges.h

   1 /* privileges.h
   2  * Declarations of routines for handling privileges.
   3  *
   4  * $Id$
   5  *
   6  * Wireshark - Network traffic analyzer
   7  * By Gerald Combs <gerald@wireshark.org>
   8  * Copyright 2006 Gerald Combs
   9  *
  10  * This program is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU General Public License
  12  * as published by the Free Software Foundation; either version 2
  13  * of the License, or (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  23  */
  24
  25 /**
  26  * Called when the program starts, to save whatever credential information
  27  * we'll need later.
  28  */
  29 extern void get_credential_info(void);
  30
  31 /**
  32  * Was this program started with special privileges?  get_credential_info()
  33  * MUST be called before calling this.
  34  * @return TRUE if the program was started with special privileges,
  35  * FALSE otherwise.
  36  */
  37 extern gboolean started_with_special_privs(void);
  38
  39 /**
  40  * Is this program running with special privileges? get_credential_info()
  41  * MUST be called before calling this.
  42  * @return TRUE if the program is running with special privileges,
  43  * FALSE otherwise.
  44  */
  45 extern gboolean running_with_special_privs(void);
  46
  47 /**
  48  * Permanently relinquish special privileges. get_credential_info()
  49  * MUST be called before calling this.
  50  */
  51 extern void relinquish_special_privs_perm(void);
  52
  53 /**
  54  * Get the current username.  String must be g_free()d after use.
  55  * @return A freshly g_alloc()ed string containing the username,
  56  * or "UNKNOWN" on failure.
  57  */
  58 extern gchar *get_cur_username(void);
  59
  60 /**
  61  * Get the current group.  String must be g_free()d after use.
  62  * @return A freshly g_alloc()ed string containing the group,
  63  * or "UNKNOWN" on failure.
  64  */
  65 extern gchar *get_cur_groupname(void);
  66
  67 #ifdef _WIN32
  68 /**
  69  * Check to see if npf.sys is running.
  70  * @return TRUE if npf.sys is running, FALSE if it's not or if there was
  71  * an error checking its status.
  72  */
  73 extern gboolean npf_sys_is_running();
  74 #endif