gsk_environment_open()--Get a handle for an SSL environment

 #include <gskssl.h>

 int gsk_environment_open(gsk_handle *my_env_handle);

The gsk_environment_open() function is used to get storage for the SSL environment. This function call must be issued before any other gsk function calls are issued. This call returns an SSL environment handle that must be saved and used on subsequent gsk calls.

Parameters

my_env_handle (Output) 

A pointer to the SSL environment handle to be used for subsequent gsk function calls.

Authorities

No authorization is required.

Return Value

gsk_environment_open() returns an integer. Possible values are:

[GSK_OK]

gsk_environment_open() was successful.

[GSK_API_NOT_AVAILABLE]

Digital Certificate Manager (DCM), 57xx-SS1 - OS400 Option 34 is not installed.

[GSK_INSUFFICIENT_STORAGE]

Not able to allocate storage for the requested operation.

[GSK_INTERNAL_ERROR]

An internal error occured during system processing.

[GSK_AS400_ERROR_INVALID_POINTER]

The my_env_handle pointer is not valid.

Error Messages

Usage Notes

1. After gsk_environment_open() returns with a GSK_OK return value, attributes for the SSL environment have been set and can be retrieved using any of the get function calls. The following is a list of the defaulted values:
   • GSK_V2_SESSION_TIMEOUT set to 100 seconds.
   • GSK_V3_SESSION_TIMEOUT set to 86400 seconds (24 hours).
   • GSK_HANDSHAKE_TIMEOUT set to 0 (wait forever).
   • GSK_OS400_RECEIVE_TIMEOUT set to 0 (wait forever).
   • GSK_SESSION_TYPE set to GSK_CLIENT_SESSION.
   • GSK_KEYRING_LABEL set to use the default certificate from the certificate store file.
   • GSK_PROTOCOL_TLSV1 set to GSK_PROTOCOL_TLSV1_ON.
   • GSK_PROTOCOL_SSLV3 set to GSK_PROTOCOL_SSLV3_ON.
   • GSK_PROTOCOL_SSLV2 set to GSK_PROTOCOL_SSLV2_ON.
   • GSK_V2_CIPHER_SPECS set to the default SSL Version 2 cipher suite list.
   • GSK_V3_CIPHER_SPECS set to the default SSL Version 3 cipher suite list.
   
   
   
2. The default cipher suite list in preference order is as follows:
   • GSK_V3_CIPHER_SPECS set to SSL Version 3 or TLS Version 1 default "04052F350A090306."
   • GSK_V2_CIPHER_SPECS set to "137624."
     
     

     See the usage notes in gsk_attribute_set_buffer() API for the format of the ciphers.

Related Information

• gsk_attribute_set_buffer()--Set character information for an secure session or a SSL environment
  
  
• gsk_attribute_set_enum()--Set enumerated information for a secure session or an SSL environment
  
  
• gsk_attribute_set_numeric_value()--Set numeric information for a secure session or an SSL environment
  
  
• gsk_environment_close()--Close the SSL environment
  
  
• gsk_environment_init()--Initialize an SSL environment
  
  
• gsk_strerror()--Retrieve GSK runtime error message