trustbridge: common/util.h annotate

annotate common/util.h @ 633:6c090638b2b4

Use static buffer for module file name. According to the msdn examle the return value of getmodulefilename should be used to indicate success and not the size. And according to comments on that function on Windows 8.1 it does not return the needed size. So better be more robust and just use max_path as a limit.

author	Andre Heinecke <andre.heinecke@intevation.de>
date	Mon, 23 Jun 2014 15:29:48 +0200
parents	78959fd970b0
children	175370634226

rev	line source
404 17e1c8f37d72 Add License Andre Heinecke <aheinecke@intevation.de> parents: 323 diff changeset	1 /* Copyright (C) 2014 by Bundesamt für Sicherheit in der Informationstechnik
17e1c8f37d72 Add License Andre Heinecke <aheinecke@intevation.de> parents: 323 diff changeset	2 * Software engineering by Intevation GmbH
17e1c8f37d72 Add License Andre Heinecke <aheinecke@intevation.de> parents: 323 diff changeset	3 *
17e1c8f37d72 Add License Andre Heinecke <aheinecke@intevation.de> parents: 323 diff changeset	4 * This file is Free Software under the GNU GPL (v>=2)
17e1c8f37d72 Add License Andre Heinecke <aheinecke@intevation.de> parents: 323 diff changeset	5 * and comes with ABSOLUTELY NO WARRANTY!
17e1c8f37d72 Add License Andre Heinecke <aheinecke@intevation.de> parents: 323 diff changeset	6 * See LICENSE.txt for details.
17e1c8f37d72 Add License Andre Heinecke <aheinecke@intevation.de> parents: 323 diff changeset	7 */
321 824ef90a6721 Move is_elevated into common/util.c file for better reuse Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	8 #ifndef COMMON_UTIL_H
824ef90a6721 Move is_elevated into common/util.c file for better reuse Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	9 #define COMMON_UTIL_H
824ef90a6721 Move is_elevated into common/util.c file for better reuse Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	10 /* @file util.h
824ef90a6721 Move is_elevated into common/util.c file for better reuse Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	11 * @brief The usual useful stuff that fit nowhere else
824ef90a6721 Move is_elevated into common/util.c file for better reuse Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	12 */
824ef90a6721 Move is_elevated into common/util.c file for better reuse Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	13 #include <stdbool.h>
824ef90a6721 Move is_elevated into common/util.c file for better reuse Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	14
505 78959fd970b0 Add is_admin and implement it for windows Andre Heinecke <aheinecke@intevation.de> parents: 404 diff changeset	15 #ifdef __cplusplus
78959fd970b0 Add is_admin and implement it for windows Andre Heinecke <aheinecke@intevation.de> parents: 404 diff changeset	16 extern "C" {
78959fd970b0 Add is_admin and implement it for windows Andre Heinecke <aheinecke@intevation.de> parents: 404 diff changeset	17 #endif
78959fd970b0 Add is_admin and implement it for windows Andre Heinecke <aheinecke@intevation.de> parents: 404 diff changeset	18
321 824ef90a6721 Move is_elevated into common/util.c file for better reuse Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	19 /**@brief Check if the current process is running with elevated privileges.
824ef90a6721 Move is_elevated into common/util.c file for better reuse Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	20 *
824ef90a6721 Move is_elevated into common/util.c file for better reuse Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	21 * Elevates the current process token to check if it is marked as elevated.
323 31ba7ed4d50f Made is_elevated portable. Sascha Wilde <wilde@intevation.de> parents: 321 diff changeset	22 * Uses TokenElevation on windows and checks effective UID on Linux.
321 824ef90a6721 Move is_elevated into common/util.c file for better reuse Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	23 *
824ef90a6721 Move is_elevated into common/util.c file for better reuse Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	24 * @returns true if the current process is elevated.*/
824ef90a6721 Move is_elevated into common/util.c file for better reuse Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	25 bool is_elevated();
323 31ba7ed4d50f Made is_elevated portable. Sascha Wilde <wilde@intevation.de> parents: 321 diff changeset	26
505 78959fd970b0 Add is_admin and implement it for windows Andre Heinecke <aheinecke@intevation.de> parents: 404 diff changeset	27 /**@brief Check if the user is in the administrators group.
78959fd970b0 Add is_admin and implement it for windows Andre Heinecke <aheinecke@intevation.de> parents: 404 diff changeset	28 *
78959fd970b0 Add is_admin and implement it for windows Andre Heinecke <aheinecke@intevation.de> parents: 404 diff changeset	29 * The function checks if the account that startet this process
78959fd970b0 Add is_admin and implement it for windows Andre Heinecke <aheinecke@intevation.de> parents: 404 diff changeset	30 * belongs to a user that is a member of the Administrators group.
78959fd970b0 Add is_admin and implement it for windows Andre Heinecke <aheinecke@intevation.de> parents: 404 diff changeset	31 *
78959fd970b0 Add is_admin and implement it for windows Andre Heinecke <aheinecke@intevation.de> parents: 404 diff changeset	32 * @returns True if the user is in the admin group. False otherwise or on error.
78959fd970b0 Add is_admin and implement it for windows Andre Heinecke <aheinecke@intevation.de> parents: 404 diff changeset	33 */
78959fd970b0 Add is_admin and implement it for windows Andre Heinecke <aheinecke@intevation.de> parents: 404 diff changeset	34 bool is_admin();
78959fd970b0 Add is_admin and implement it for windows Andre Heinecke <aheinecke@intevation.de> parents: 404 diff changeset	35
78959fd970b0 Add is_admin and implement it for windows Andre Heinecke <aheinecke@intevation.de> parents: 404 diff changeset	36 #ifdef __cplusplus
78959fd970b0 Add is_admin and implement it for windows Andre Heinecke <aheinecke@intevation.de> parents: 404 diff changeset	37 }
78959fd970b0 Add is_admin and implement it for windows Andre Heinecke <aheinecke@intevation.de> parents: 404 diff changeset	38 #endif
78959fd970b0 Add is_admin and implement it for windows Andre Heinecke <aheinecke@intevation.de> parents: 404 diff changeset	39
321 824ef90a6721 Move is_elevated into common/util.c file for better reuse Andre Heinecke <aheinecke@intevation.de> parents: diff changeset	40 #endif // COMMON_UTIL_H

Mercurial > trustbridge

annotate common/util.h @ 633:6c090638b2b4