System i: Programming Secure Sockets APIs - IBM

More documents

Recommendations

Info

ufID (Input) The following values can be used to retrieve information about the secure session or the SSL environment that is either defaulted or explicitly set: v GSK_KEYRING_FILE (201) - buffer points to the name of the certificate store file being used for the SSL environment. v GSK_KEYRING_PW (202) - buffer points to the password for the certificate store file being used for the SSL environment. v GSK_KEYRING_LABEL (203) - buffer points to the certificate label associated with the certificate in the certificate store identified by GSK_KEYRING_FILE to be used for the secure session or SSL environment. v GSK_OS400_APPLICATION_ID (6999) - buffer points to the application identifier being used for the SSL environment. v GSK_V2_CIPHER_SPECS (205) - buffer points to the list of available SSL Version 2 ciphers to be used for the secure session or the SSL environment. See the usage notes in “gsk_attribute_set_buffer()—Set character information for a secure session or an SSL environment” on page 16 API for the format of the ciphers. v GSK_V3_CIPHER_SPECS (206) - buffer points to the list of available SSL Version 3 or TLS Version 1 ciphers to be used for the secure session or the SSL environment. See the usage notes in “gsk_attribute_set_buffer()—Set character information for a secure session or an SSL environment” on page 16 API for the format of the ciphers. v GSK_CONNECT_SEC_TYPE (208) - buffer points to a string containing ″SSLV2,″ ″SSLV3,″ or ″TLSV1,″ depending on what was actually negotiated for use by the secure session. v GSK_CONNECT_CIPHER_SPEC (207) - buffer points to a one- or two-character string describing the cipher specification negotiated for use by the secure session. See the usage notes in “gsk_attribute_set_buffer()—Set character information for a secure session or an SSL environment” on page 16 API for the format of the ciphers. v GSK_SID_VALUE (212) - buffer points to a string containing the session ID (SID) used for the secure session. buffer (Output) The address of the location to place the pointer that will point to the buffer containing the requested information. The storage for this information was allocated by the system from user heap storage and will be freed by the gsk_secure_soc_close() API or the gsk_environment_close() API. The data in the buffer is assumed to be represented in the CCSID (coded character set identifier) currently in effect for the job. If the CCSID of the job is 65535, this buffer is assumed to be represented in the default CCSID of the job. bufSize (Output) The address of the location to store the length of the requested information pointed to by buffer. Authorities No authorization is required. Return Value gsk_attribute_get_buffer() returns an integer. Possible values are: [GSK_OK] gsk_attribute_get_buffer() was successful. 4 System i: Programming Secure Sockets APIs
[GSK_ATTRIBUTE_INVALID_ID] The specified bufID was not valid. [GSK_INVALID_HANDLE] The specified handle was not valid. [GSK_AS400_ERROR_INVALID_POINTER] The buffer or bufSize pointer is not valid. [GSK_ERROR_UNSUPPORTED] The bufID currently is not supported. [GSK_ERROR_IO] An error occurred in SSL processing. Check the errno value. Error Conditions When the gsk_attribute_get_buffer() API fails with return code [GSK_ERROR_IO], errno can be set to: [EINTR] Interrupted function call. [EDEADLK] Resource deadlock avoided. [ETERM] Operation terminated. If an errno is returned that is not in this list, look in “Errno Values for UNIX-Type Functions” on page 103 for a description of the errno. Usage Notes 1. The following GSK_BUF_ID values may be retrieved from the SSL environment after gsk_environment_open(). v GSK_KEYRING_FILE v GSK_KEYRING_PW v GSK_KEYRING_LABEL v GSK_OS400_APPLICATION_ID v GSK_V2_CIPHER_SPECS v GSK_V3_CIPHER_SPECS 2. The following GSK_BUF_ID values may be retrieved from the secure session after gsk_secure_soc_open(). v GSK_KEYRING_LABEL v GSK_V2_CIPHER_SPECS v GSK_V3_CIPHER_SPECS v GSK_CONNECT_SEC_TYPE v GSK_CONNECT_CIPHER_SPEC 3. The following GSK_BUF_ID values are defaulted after gsk_secure_soc_open() and will be set for the secure session after gsk_secure_soc_init(). v GSK_CONNECT_SEC_TYPE v GSK_CONNECT_CIPHER_SPEC v GSK_SID_VALUE 4. The following GSK_BUF_ID values may be changed for the secure session after gsk_secure_soc_misc(), gsk_secure_soc_read() or gsk_secure_soc_startRecv() if an SSL Handshake happened under the context of those calls for the secure session. Secure Sockets APIs 5
Page 1: System i Programming Secure Sockets
Page 4 and 5: Note Before using this information
Page 6 and 7: Related Information . . . . . . . .
Page 8 and 9: vi System i: Programming Secure Soc
Page 10 and 11: APIs These are the APIs for this ca
Page 14 and 15: v GSK_CONNECT_CIPHER_SPEC v GSK_SID
Page 16 and 17: [GSK_INSUFFICIENT_STORAGE] Not able
Page 18 and 19: gsk_attribute_get_enum()—Get enum
Page 20 and 21: secure session does not start, and
Page 22 and 23: API introduced: V5R1 Top | UNIX-Typ
Page 24 and 25: v GSK_FD v GSK_HANDSHAKE_TIMEOUT v
Page 26 and 27: [GSK_INVALID_STATE] One of the foll
Page 28 and 29: 8. If GSK_OS400_APPLICATION_ID is s
Page 30 and 31: if validation fails because the cer
Page 32 and 33: gsk_attribute_set_enum()—Set enum
Page 34 and 35: active secure sessions will continu
Page 36 and 37: gsk_attribute_set_numeric_value()
Page 38 and 39: v GSK_V3_SIDCACHE_SIZE v GSK_LDAP_S
Page 40 and 41: v “gsk_secure_soc_init()—Negoti
Page 42 and 43: [ETERM] Operation terminated. If an
Page 44 and 45: 2. v GSK_SESSION_TYPE set to GSK_CL
Page 46 and 47: Error Messages Message ID Error Mes
Page 48 and 49: [GSK_AS400_ERROR_INVALID_POINTER] T
Page 50 and 51: attributes. In most cases, as resul
Page 52 and 53: Error Messages Message ID Error Mes
Page 54 and 55: v “gsk_secure_soc_misc()—Perfor
Page 56 and 57: matched sets. If a client applicati
Page 58 and 59: Authorities Authorization of *R (al
Page 60 and 61: gsk_secure_soc_startRecv()—Start
Page 62 and 63:
The handle specified was not valid.
Page 64 and 65:
v “gsk_secure_soc_misc()—Perfor
Page 66 and 67:
Authorities No authorization is req
Page 68 and 69:
6. Socket option SO_SNDTIMEO is not
Page 70 and 71:
[EPIPE] [EUNATCH] The specified des
Page 72 and 73:
Example The following example shows
Page 74 and 75:
Qlg_Path_Name_T *keyringFileName (i
Page 76 and 77:
v The CCSID specified in the keyrin
Page 78 and 79:
unsigned protocol; /* SSL protocol
Page 80 and 81:
Service Program Name: QSOSSLSR Defa
Page 82 and 83:
Related Information v “SSL_Create
Page 84 and 85:
unsigned int cipherSuiteListLen The
Page 86 and 87:
[EBADF] [EBUSY] Permission denied.
Page 88 and 89:
ignore attempts by applications to
Page 90 and 91:
C Constant System Value TLS_RSA_WIT
Page 92 and 93:
ignore attempts by applications to
Page 94 and 95:
v Use the system default cipher spe
Page 96 and 97:
An error occurred in SSL processing
Page 98 and 99:
Parameters int sslreturnvalue (Inpu
Page 100 and 101:
Parameters SSLHandle* handle (input
Page 102 and 103:
[EUNATCH] [EUNKNOWN] The protocol r
Page 104 and 105:
Authorities No authorization is req
Page 106 and 107:
struct SSLHandleStr { /* SSLHandleS
Page 108 and 109:
Error Messages Message ID Error Mes
Page 110 and 111:
Name of Header File Name of File in
Page 112 and 113:
Name Value Text Details ENOTWRITE 3
Page 114 and 115:
Name Value Text Details EHOSTDOWN 3
Page 116 and 117:
Name Value Text Details EISDIR 3471
Page 118 and 119:
Name Value Text Details EBADFID 351
Page 120 and 121:
CONDITIONS OF MERCHANTABILITY, FITN
Page 122 and 123:
IBM Corporation Software Interopera
Page 124 and 125:
SAA SecureWay SOM System i System i
Page 126:
118 System i: Programming Secure So
show all

System i: Programming Secure Sockets APIs - IBM

Create successful ePaper yourself

Delete template?

Save as template?