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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  23  */
  24
  25 #ifndef __PRIVILEGES_H__
  26 #define __PRIVILEGES_H__
  27
  28 #include "ws_symbol_export.h"
  29
  30 #ifdef __cplusplus
  31 extern "C" {
  32 #endif
  33
  34 /**
  35  * Called when the program starts, to enable security features and save
  36  * whatever credential information we'll need later.
  37  */
  38 WS_DLL_PUBLIC void init_process_policies(void);
  39
  40 /**
  41  * Was this program started with special privileges?  get_credential_info()
  42  * MUST be called before calling this.
  43  * @return TRUE if the program was started with special privileges,
  44  * FALSE otherwise.
  45  */
  46 WS_DLL_PUBLIC gboolean started_with_special_privs(void);
  47
  48 /**
  49  * Is this program running with special privileges? get_credential_info()
  50  * MUST be called before calling this.
  51  * @return TRUE if the program is running with special privileges,
  52  * FALSE otherwise.
  53  */
  54 WS_DLL_PUBLIC gboolean running_with_special_privs(void);
  55
  56 /**
  57  * Permanently relinquish special privileges. get_credential_info()
  58  * MUST be called before calling this.
  59  */
  60 WS_DLL_PUBLIC void relinquish_special_privs_perm(void);
  61
  62 /**
  63  * Get the current username.  String must be g_free()d after use.
  64  * @return A freshly g_alloc()ed string containing the username,
  65  * or "UNKNOWN" on failure.
  66  */
  67 WS_DLL_PUBLIC gchar *get_cur_username(void);
  68
  69 /**
  70  * Get the current group.  String must be g_free()d after use.
  71  * @return A freshly g_alloc()ed string containing the group,
  72  * or "UNKNOWN" on failure.
  73  */
  74 WS_DLL_PUBLIC gchar *get_cur_groupname(void);
  75
  76 #ifdef _WIN32
  77 /**
  78  * Check to see if npf.sys is running.
  79  * @return TRUE if npf.sys is running, FALSE if it's not or if there was
  80  * an error checking its status.
  81  */
  82 WS_DLL_PUBLIC gboolean npf_sys_is_running();
  83 #endif
  84
  85 #ifdef __cplusplus
  86 }
  87 #endif /* __cplusplus */
  88
  89 #endif /* __PRIVILEGES_H__ */