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