Provided by: libglobus-gsi-sysconfig-doc_9.2-2_all bug

NAME

       globus_gsi_system_config_defines - Defines.

SYNOPSIS

   Macros
       #define GLOBUS_GSI_SYSCONFIG_SET_KEY_PERMISSIONS
       #define GLOBUS_GSI_SYSCONFIG_GET_HOME_DIR
       #define GLOBUS_GSI_SYSCONFIG_CHECK_KEYFILE
       #define GLOBUS_GSI_SYSCONFIG_CHECK_KEYFILE_UID
       #define GLOBUS_GSI_SYSCONFIG_CHECK_CERTFILE
       #define GLOBUS_GSI_SYSCONFIG_CHECK_CERTFILE_UID
       #define GLOBUS_GSI_SYSCONFIG_FILE_EXISTS
       #define GLOBUS_GSI_SYSCONFIG_DIR_EXISTS
       #define GLOBUS_GSI_SYSCONFIG_GET_CERT_DIR
       #define GLOBUS_GSI_SYSCONFIG_GET_USER_CERT_FILENAME
       #define GLOBUS_GSI_SYSCONFIG_GET_HOST_CERT_FILENAME
       #define GLOBUS_GSI_SYSCONFIG_GET_SERVICE_CERT_FILENAME
       #define GLOBUS_GSI_SYSCONFIG_GET_PROXY_FILENAME
       #define GLOBUS_GSI_SYSCONFIG_GET_SIGNING_POLICY_FILENAME
       #define GLOBUS_GSI_SYSCONFIG_GET_CA_CERT_FILES
       #define GLOBUS_GSI_SYSCONFIG_GET_CURRENT_WORKING_DIR
       #define GLOBUS_GSI_SYSCONFIG_MAKE_ABSOLUTE_PATH_FOR_FILENAME
       #define GLOBUS_GSI_SYSCONFIG_SPLIT_DIR_AND_FILENAME
       #define GLOBUS_GSI_SYSCONFIG_REMOVE_ALL_OWNED_FILES
       #define GLOBUS_GSI_SYSCONFIG_GET_GRIDMAP_FILENAME
       #define GLOBUS_GSI_SYSCONFIG_GET_AUTHZ_CONF_FILENAME
       #define GLOBUS_GSI_SYSCONFIG_GET_GAA_CONF_FILENAME
       #define GLOBUS_GSI_SYSCONFIG_IS_SUPERUSER
       #define GLOBUS_GSI_SYSCONFIG_GET_USER_ID_STRING
       #define GLOBUS_GSI_SYSCONFIG_GET_PROC_ID_STRING
       #define GLOBUS_GSI_SYSCONFIG_GET_USERNAME
       #define GLOBUS_GSI_SYSCONFIG_GET_UNIQUE_PROXY_FILENAME
       #define GLOBUS_GSI_SYSCONFIG_GET_VHOST_CRED_DIR

Detailed Description

       Defines.

       These preprocessor defines allow for a platform (ie Win32 vs UNIX) independent API.

Macro Definition Documentation

   #define GLOBUS_GSI_SYSCONFIG_CHECK_CERTFILE
       Check for the correct file permissions on a certificate.

       See globus_gsi_sysconfig_check_certfile_unix() and
       globus_gsi_sysconfig_check_certfile_win32()

   #define GLOBUS_GSI_SYSCONFIG_CHECK_CERTFILE_UID
       Check for the correct file permissions on a certificate owned by a particular user id.

       See globus_gsi_sysconfig_check_certfile_uid_junix() and
       globus_gsi_sysconfig_check_certfile_uid_jwin32()

   #define GLOBUS_GSI_SYSCONFIG_CHECK_KEYFILE
       Check for the correct file permissions on a private key.

       See globus_gsi_sysconfig_check_keyfile_unix() and
       globus_gsi_sysconfig_check_keyfile_win32()

   #define GLOBUS_GSI_SYSCONFIG_CHECK_KEYFILE_UID
       Check for the correct file permissions on a private key owned by a particular user id.

       See globus_gsi_sysconfig_check_keyfile_unix() and
       globus_gsi_sysconfig_check_keyfile_win32()

   #define GLOBUS_GSI_SYSCONFIG_DIR_EXISTS
       Check whether a given directory exists

       See globus_gsi_sysconfig_dir_exists_unix() and globus_gsi_sysconfig_dir_exists_win32()

   #define GLOBUS_GSI_SYSCONFIG_FILE_EXISTS
       Check whether a given file exists

       See globus_gsi_sysconfig_file_exists_unix() and globus_gsi_sysconfig_file_exists_win32()

   #define GLOBUS_GSI_SYSCONFIG_GET_AUTHZ_CONF_FILENAME
       Determine the location of the authorization callout config file.

       See globus_gsi_sysconfig_get_authz_conf_filename_unix()

   #define GLOBUS_GSI_SYSCONFIG_GET_CA_CERT_FILES
       Get a list of of trusted CA certificate filenames in a trusted CA certificate directory.

       See globus_gsi_sysconfig_get_ca_cert_files_unix() and
       globus_gsi_sysconfig_get_ca_cert_files_win32()

   #define GLOBUS_GSI_SYSCONFIG_GET_CERT_DIR
       Determine the location of the trusted certificates directory

       See globus_gsi_sysconfig_get_cert_dir_unix() and globus_gsi_sysconfig_get_cert_dir_win32()

   #define GLOBUS_GSI_SYSCONFIG_GET_CURRENT_WORKING_DIR
       Get the current working directory

       See globus_gsi_sysconfig_get_current_working_dir_unix() and
       globus_gsi_sysconfig_get_current_working_dir_win32()

   #define GLOBUS_GSI_SYSCONFIG_GET_GAA_CONF_FILENAME
       Determine the location of the GAA callout config file.

       See globus_gsi_sysconfig_get_gaa_conf_filename_unix()

   #define GLOBUS_GSI_SYSCONFIG_GET_GRIDMAP_FILENAME
       Determine the location of the grid map file.

       See globus_gsi_sysconfig_get_gridmap_filename_unix() and
       globus_gsi_sysconfig_get_gridmap_filename_win32()

   #define GLOBUS_GSI_SYSCONFIG_GET_HOME_DIR
       Get the current users home directory

       See globus_gsi_sysconfig_get_home_dir_unix() and globus_gsi_sysconfig_get_home_dir_win32()

   #define GLOBUS_GSI_SYSCONFIG_GET_HOST_CERT_FILENAME
       Determine the location of the host certificate and private key

       See globus_gsi_sysconfig_get_host_cert_filename_unix() and
       globus_gsi_sysconfig_get_host_cert_filename_win32()

   #define GLOBUS_GSI_SYSCONFIG_GET_PROC_ID_STRING
       Get the current PID in string form

       See globus_gsi_sysconfig_get_proc_id_string_unix() and
       globus_gsi_sysconfig_get_proc_id_string_win32()

   #define GLOBUS_GSI_SYSCONFIG_GET_PROXY_FILENAME
       Determine the location of a proxy certificate and private key

       See globus_gsi_sysconfig_get_proxy_filename_unix() and
       globus_gsi_sysconfig_get_proxy_filename_win32()

   #define GLOBUS_GSI_SYSCONFIG_GET_SERVICE_CERT_FILENAME
       Determine the location of a service certificate and private key

       See globus_gsi_sysconfig_get_service_cert_filename_unix() and
       globus_gsi_sysconfig_get_service_cert_filename_win32()

   #define GLOBUS_GSI_SYSCONFIG_GET_SIGNING_POLICY_FILENAME
       Determine the name of the signing policy file for a given CA

       See globus_gsi_sysconfig_get_signing_policy_filename_unix() and
       globus_gsi_sysconfig_get_signing_policy_filename_win32()

   #define GLOBUS_GSI_SYSCONFIG_GET_UNIQUE_PROXY_FILENAME
       Generate a unique proxy file name

       See globus_gsi_sysconfig_get_unique_proxy_filename()

   #define GLOBUS_GSI_SYSCONFIG_GET_USER_CERT_FILENAME
       Determine the location of the users certificate and private key

       See globus_gsi_sysconfig_get_user_cert_filename_unix() and
       globus_gsi_sysconfig_get_user_cert_filename_win32()

   #define GLOBUS_GSI_SYSCONFIG_GET_USER_ID_STRING
       Get the current UID in string form

       See globus_gsi_sysconfig_get_user_id_string_unix() and
       globus_gsi_sysconfig_get_user_id_string_win32()

   #define GLOBUS_GSI_SYSCONFIG_GET_USERNAME
       Get the current user name

       See globus_gsi_sysconfig_get_username_unix() and globus_gsi_sysconfig_get_username_win32()

   #define GLOBUS_GSI_SYSCONFIG_GET_VHOST_CRED_DIR
       Determine the location of the vhost credentials directory

       See globus_gsi_sysconfig_get_vhost_cred_dir()

   #define GLOBUS_GSI_SYSCONFIG_IS_SUPERUSER
       Determine whether the current user is the super user

       See globus_gsi_sysconfig_is_superuser_unix() and globus_gsi_sysconfig_is_superuser_win32()

   #define GLOBUS_GSI_SYSCONFIG_MAKE_ABSOLUTE_PATH_FOR_FILENAME
       Prepend the current working directory to the give filename

       See globus_gsi_sysconfig_make_absolute_path_for_filename_unix() and
       globus_gsi_sysconfig_make_absolute_path_for_filename_win32()

   #define GLOBUS_GSI_SYSCONFIG_REMOVE_ALL_OWNED_FILES
       Remove all proxies owned by current uid

       See globus_gsi_sysconfig_remove_all_owned_files_unix() and
       globus_gsi_sysconfig_remove_all_owned_files_win32()

   #define GLOBUS_GSI_SYSCONFIG_SET_KEY_PERMISSIONS
       Set the correct file permissions on a private key.

       See globus_gsi_sysconfig_set_key_permissions_unix() and
       globus_gsi_sysconfig_set_key_permissions_win32()

   #define GLOBUS_GSI_SYSCONFIG_SPLIT_DIR_AND_FILENAME
       Split directory component of path from filename.

       See globus_gsi_sysconfig_split_dir_and_filename_unix() and
       globus_gsi_sysconfig_split_dir_and_filename_win32()

Author

       Generated automatically by Doxygen for globus_gsi_sysconfig from the source code.