gsk_attribute_get_numeric_value()

Gets a numeric value.

Format

   #include <gskssl.h>

   gsk_status gsk_attribute_get_numeric_value (
                                                gsk_handle     ssl_handle,
                                                GSK_NUM_ID     num_id,
                                                int *          num_value)

Parameters

ssl_handle: Specifies an SSL environment handle returned by gsk_environment_open() or an SSL connection handle returned by gsk_secure_socket_open().
num_id: Specifies the numeric identifier.
num_value: Returns the numeric value.

Results

The function return value will be 0 (GSK_OK) if no error is detected. Otherwise, it will be one of the return codes listed in the gskssl.h include file. These are some possible errors:

[GSK_ATTRIBUTE_INVALID_ID]: The numeric identifier is not valid or cannot be used with the specified handle.
[GSK_INVALID_HANDLE]: The handle is not valid.
[GSK_INVALID_STATE]: The environment is closed.

Usage

The gsk_attribute_get_numeric_value() routine will return a numeric value for an SSL environment or an SSL connection.

These numeric identifiers are supported:

GSK_CRL_CACHE_ENTRY_MAXSIZE: Returns the maximum size in bytes of a CRL that is allowed to be stored in the LDAP CRL cache. Any CRLs larger than this size are not cached. GSK_CRL_CACHE_ENTRY_MAXSIZE can be specified only for an SSL environment.
GSK_CRL_CACHE_SIZE: Returns the maximum number of CRLs that are allowed to be stored in the LDAP CRL cache. GSK_CRL_CACHE_SIZE can be specified only for an SSL environment.
GSK_CRL_CACHE_TEMP_CRL_TIMEOUT: Returns the time in hours that a temporary CRL cache entry resides in the LDAP extended CRL cache. GSK_CRL_CACHE_TEMP_CRL_TIMEOUT can be specified only for an SSL environment.
GSK_CRL_CACHE_TIMEOUT: Returns the LDAP basic CRL cache timeout. GSK_CRL_CACHE_TIMEOUT can be specified only for an SSL environment.
GSK_FD: Returns the socket descriptor used for network operations. GSK_FD can be specified only for an SSL connection.
GSK_HTTP_CDP_CACHE_ENTRY_MAXSIZE: Returns the maximum size in bytes of a CRL that is allowed to be stored in the HTTP CDP CRL cache. GSK_HTTP_CDP_CACHE_ENTRY_MAXSIZE can be specified only for an SSL environment.
GSK_HTTP_CDP_CACHE_SIZE: Returns the maximum number of CRLs that are allowed to be stored in the HTTP CDP CRL cache. GSK_HTTP_CDP_CACHE_SIZE can be specified only for an SSL environment.
GSK_HTTP_CDP_MAX_RESPONSE_SIZE: Returns the maximum size in bytes accepted as a response from an HTTP server when retrieving a CRL. GSK_HTTP_CDP_MAX_RESPONSE_SIZE can be specified only for an SSL environment.
GSK_HTTP_CDP_PROXY_SERVER_PORT: Returns the HTTP proxy server port for HTTP CDP CRL retrieval. GSK_HTTP_CDP_PROXY_SERVER_PORT can be specified only for an SSL environment.
GSK_HTTP_CDP_RESPONSE_TIMEOUT: Returns the time in seconds to wait for a response from the HTTP server. GSK_HTTP_CDP_RESPONSE_TIMEOUT can be specified only for an SSL environment.
GSK_LDAP_RESPONSE_TIMEOUT: Returns the time in seconds to wait for a response from the LDAP server. GSK_LDAP_RESPONSE_TIMEOUT can be specified only for an SSL environment.
GSK_LDAP_SERVER_PORT: Returns the LDAP server port. GSK_LDAP_SERVER_PORT can be specified only for an SSL environment.
GSK_MAX_SOURCE_REV_EXT_LOC_VALUES: Returns the maximum number of location values that will be contacted for each revocation source when performing validation of a certificate. GSK_MAX_SOURCE_REV_EXT_LOC_VALUES can be specified only for an SSL environment.
GSK_MAX_VALIDATION_REV_EXT_LOC_VALUES: Returns the maximum number of location values that will be contacted when performing validation of a certificate. GSK_MAX_VALIDATION_REV_EXT_LOC_VALUES can be specified only for an SSL environment.
GSK_OCSP_CLIENT_CACHE_ENTRY_MAXSIZE: Returns the maximum number of OCSP responses or cached certificate statuses that are allowed to be kept in the OCSP response cache for an issuing CA certificate. GSK_OCSP_CLIENT_CACHE_ENTRY_MAXSIZE can be specified only for an SSL environment.
GSK_OCSP_CLIENT_CACHE_SIZE: Returns the maximum number of OCSP responses or cached certificate statuses to be kept in the OCSP response cache. GSK_OCSP_CLIENT_CACHE_SIZE can only be specified for an SSL environment.
GSK_OCSP_MAX_RESPONSE_SIZE: Returns the maximum size in bytes allowed in a response from an OCSP responder. GSK_OCSP_MAX_RESPONSE_SIZE can be specified only for an SSL environment.
GSK_OCSP_NONCE_SIZE: Returns the size in bytes of the nonce that will be sent in OCSP requests. GSK_OCSP_NONCE_SIZE can be specified only for an SSL environment.
GSK_OCSP_PROXY_SERVER_PORT: Returns the port for the OCSP responder proxy server. GSK_OCSP_PROXY_SERVER_PORT can be specified only for an SSL environment.
GSK_OCSP_RESPONSE_TIMEOUT: Returns the time in seconds to wait for a response from the OCSP responder. GSK_OCSP_RESPONSE_TIMEOUT can be specified only for an SSL environment.
GSK_PEER_DH_MIN_KEY_SIZE: Returns the X.509 certificate Diffie-Hellman minimum allowed key size for the peer end-entity certificate. GSK_PEER_DH_MIN_KEY_SIZE can be specified only for an SSL environment.
GSK_PEER_DSA_MIN_KEY_SIZE: Returns the X.509 certificate DSA minimum allowed key size for the peer end-entity certificate. GSK_PEER_DSA_MIN_KEY_SIZE can be specified only for an SSL environment.
GSK_PEER_ECC_MIN_KEY_SIZE: Returns the X.509 certificate ECC minimum allowed key size for the peer end-entity certificate. GSK_PEER_ECC_MIN_KEY_SIZE can be specified only for an SSL environment.
GSK_PEER_RSA_MIN_KEY_SIZE: Returns the X.509 certificate RSA minimum allowed key size for the peer end-entity certificate. GSK_PEER_RSA_MIN_KEY_SIZE can be specified only for an SSL environment.
GSK_V2_SESSION_TIMEOUT: Returns the SSL Version 2 session timeout. GSK_V2_SESSION_TIMEOUT can be specified only for an SSL environment.
GSK_V2_SIDCACHE_SIZE: Returns the size of the SSL Version 2 session identifier cache. GSK_V2_SIDCACHE_SIZE can be specified only for an SSL environment.
GSK_V3_SESSION_TIMEOUT: Returns the SSL Version 3 session timeout. GSK_V3_SESSION_TIMEOUT can be specified only for an SSL environment.
GSK_V3_SIDCACHE_SIZE: Returns the size of the SSL Version 3 session identifier cache. GSK_V3_SIDCACHE_SIZE can be specified only for an SSL environment.