2013-06-18 01:59:18 +00:00
|
|
|
/* Licensed to the Apache Software Foundation (ASF) under one or more
|
|
|
|
* contributor license agreements. See the NOTICE file distributed with
|
|
|
|
* this work for additional information regarding copyright ownership.
|
|
|
|
* The ASF licenses this file to You under the Apache License, Version 2.0
|
|
|
|
* (the "License"); you may not use this file except in compliance with
|
|
|
|
* the License. You may obtain a copy of the License at
|
|
|
|
*
|
|
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
*
|
|
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
* See the License for the specific language governing permissions and
|
|
|
|
* limitations under the License.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef APR_USER_H
|
|
|
|
#define APR_USER_H
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @file apr_user.h
|
|
|
|
* @brief APR User ID Services
|
|
|
|
*/
|
|
|
|
|
|
|
|
#include "apr.h"
|
|
|
|
#include "apr_errno.h"
|
|
|
|
#include "apr_pools.h"
|
|
|
|
|
|
|
|
#ifdef __cplusplus
|
|
|
|
extern "C" {
|
|
|
|
#endif /* __cplusplus */
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @defgroup apr_user User and Group ID Services
|
|
|
|
* @ingroup APR
|
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Structure for determining user ownership.
|
|
|
|
*/
|
|
|
|
#ifdef WIN32
|
|
|
|
typedef PSID apr_uid_t;
|
|
|
|
#else
|
|
|
|
typedef uid_t apr_uid_t;
|
|
|
|
#endif
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Structure for determining group ownership.
|
|
|
|
*/
|
|
|
|
#ifdef WIN32
|
|
|
|
typedef PSID apr_gid_t;
|
|
|
|
#else
|
|
|
|
typedef gid_t apr_gid_t;
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#if APR_HAS_USER
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the userid (and groupid) of the calling process
|
|
|
|
* @param userid Returns the user id
|
|
|
|
* @param groupid Returns the user's group id
|
|
|
|
* @param p The pool from which to allocate working space
|
|
|
|
* @remark This function is available only if APR_HAS_USER is defined.
|
|
|
|
*/
|
|
|
|
APR_DECLARE(apr_status_t) apr_uid_current(apr_uid_t *userid,
|
|
|
|
apr_gid_t *groupid,
|
|
|
|
apr_pool_t *p);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the user name for a specified userid
|
|
|
|
* @param username Pointer to new string containing user name (on output)
|
|
|
|
* @param userid The userid
|
|
|
|
* @param p The pool from which to allocate the string
|
|
|
|
* @remark This function is available only if APR_HAS_USER is defined.
|
|
|
|
*/
|
|
|
|
APR_DECLARE(apr_status_t) apr_uid_name_get(char **username, apr_uid_t userid,
|
|
|
|
apr_pool_t *p);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the userid (and groupid) for the specified username
|
|
|
|
* @param userid Returns the user id
|
|
|
|
* @param groupid Returns the user's group id
|
2014-05-27 07:00:33 +00:00
|
|
|
* @param username The username to look up
|
2013-06-18 01:59:18 +00:00
|
|
|
* @param p The pool from which to allocate working space
|
|
|
|
* @remark This function is available only if APR_HAS_USER is defined.
|
|
|
|
*/
|
|
|
|
APR_DECLARE(apr_status_t) apr_uid_get(apr_uid_t *userid, apr_gid_t *groupid,
|
|
|
|
const char *username, apr_pool_t *p);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the home directory for the named user
|
|
|
|
* @param dirname Pointer to new string containing directory name (on output)
|
|
|
|
* @param username The named user
|
|
|
|
* @param p The pool from which to allocate the string
|
|
|
|
* @remark This function is available only if APR_HAS_USER is defined.
|
|
|
|
*/
|
|
|
|
APR_DECLARE(apr_status_t) apr_uid_homepath_get(char **dirname,
|
|
|
|
const char *username,
|
|
|
|
apr_pool_t *p);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Compare two user identifiers for equality.
|
|
|
|
* @param left One uid to test
|
|
|
|
* @param right Another uid to test
|
2014-05-27 07:00:33 +00:00
|
|
|
* @return APR_SUCCESS if the apr_uid_t structures identify the same user,
|
2013-06-18 01:59:18 +00:00
|
|
|
* APR_EMISMATCH if not, APR_BADARG if an apr_uid_t is invalid.
|
|
|
|
* @remark This function is available only if APR_HAS_USER is defined.
|
|
|
|
*/
|
|
|
|
#if defined(WIN32)
|
|
|
|
APR_DECLARE(apr_status_t) apr_uid_compare(apr_uid_t left, apr_uid_t right);
|
|
|
|
#else
|
|
|
|
#define apr_uid_compare(left,right) (((left) == (right)) ? APR_SUCCESS : APR_EMISMATCH)
|
|
|
|
#endif
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the group name for a specified groupid
|
|
|
|
* @param groupname Pointer to new string containing group name (on output)
|
|
|
|
* @param groupid The groupid
|
|
|
|
* @param p The pool from which to allocate the string
|
|
|
|
* @remark This function is available only if APR_HAS_USER is defined.
|
|
|
|
*/
|
|
|
|
APR_DECLARE(apr_status_t) apr_gid_name_get(char **groupname,
|
|
|
|
apr_gid_t groupid, apr_pool_t *p);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the groupid for a specified group name
|
|
|
|
* @param groupid Pointer to the group id (on output)
|
|
|
|
* @param groupname The group name to look up
|
|
|
|
* @param p The pool from which to allocate the string
|
|
|
|
* @remark This function is available only if APR_HAS_USER is defined.
|
|
|
|
*/
|
|
|
|
APR_DECLARE(apr_status_t) apr_gid_get(apr_gid_t *groupid,
|
|
|
|
const char *groupname, apr_pool_t *p);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Compare two group identifiers for equality.
|
|
|
|
* @param left One gid to test
|
|
|
|
* @param right Another gid to test
|
2014-05-27 07:00:33 +00:00
|
|
|
* @return APR_SUCCESS if the apr_gid_t structures identify the same group,
|
2013-06-18 01:59:18 +00:00
|
|
|
* APR_EMISMATCH if not, APR_BADARG if an apr_gid_t is invalid.
|
|
|
|
* @remark This function is available only if APR_HAS_USER is defined.
|
|
|
|
*/
|
|
|
|
#if defined(WIN32)
|
|
|
|
APR_DECLARE(apr_status_t) apr_gid_compare(apr_gid_t left, apr_gid_t right);
|
|
|
|
#else
|
|
|
|
#define apr_gid_compare(left,right) (((left) == (right)) ? APR_SUCCESS : APR_EMISMATCH)
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#endif /* ! APR_HAS_USER */
|
|
|
|
|
|
|
|
/** @} */
|
|
|
|
|
|
|
|
#ifdef __cplusplus
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#endif /* ! APR_USER_H */
|