System i: Programming Secure Sockets APIs - IBM

More documents

Recommendations

Info

2. v GSK_SESSION_TYPE set to GSK_CLIENT_SESSION. v GSK_KEYRING_LABEL set to use the default certificate from the certificate store file. v GSK_PROTOCOL_TLSV1 set to GSK_PROTOCOL_TLSV1_ON. v GSK_PROTOCOL_SSLV3 set to GSK_PROTOCOL_SSLV3_ON. v GSK_PROTOCOL_SSLV2 set to GSK_PROTOCOL_SSLV2_OFF. v GSK_V2_CIPHER_SPECS set to the default SSL Version 2 cipher suite list. v GSK_V3_CIPHER_SPECS set to the default SSL Version 3 cipher suite list. The default cipher suite list in preference order as shipped is as follows: v GSK_V3_CIPHER_SPECS set to SSL Version 3 or TLS Version 1 default ″2F0504350A.″ v GSK_V2_CIPHER_SPECS set to ″137.″ The current default cipher suite list can be different from the install time list due to changes made to the QSSLCSL (SSL cipher specification list) system value via the Change System Value (CHGSYSVAL) command. A cipher suite removed from the SSL cipher specification list will also be removed from the default cipher suite list shown here. The order of the cipher suites in QSSLCSL will be used to order the cipher suites in the default list. “gsk_attribute_get_buffer()—Get character information about a secure session or an SSL environment” on page 3 for GSK_V3_CIPHER_SPECS can be used to determine the current default cipher suite list configuration. 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. 3. The default values for GSK_PROTOCOL_TLSV1 and GSK_PROTOCOL_SSLV3 can be altered by changing the QSSLPCL (SSL protocols) system value via the Change System Value (CHGSYSVAL) command. When a protocol is removed from the SSL protocols system value it results in the protocol being set to off rather than on by default. “gsk_attribute_get_enum()—Get enumerated information about a secure session or an SSL environment” on page 10 for each of those values can be used to determine the current default protocols enabled. 4. The Display System Value (DSPSYSVAL) command or the Retrieve System Values (QWCRSVAL) API can be used to determine the current settings of the supported ciphers and protocols for system SSL. 5. Change System Value (CHGSYSVAL) allows an administrator to disable protocols or ciphers from being used by the GSKit APIs. For backwards compatibility, GSKit support will silently ignore attempts by applications to use disabled protocols or ciphers unless only disabled values are used. Related Information v “gsk_attribute_set_buffer()—Set character information for a secure session or an SSL environment” on page 16—Set character information for an secure session or a SSL environment v “gsk_attribute_set_enum()—Set enumerated information for a secure session or an SSL environment” on page 24—Set enumerated information for a secure session or an SSL environment v “gsk_attribute_set_numeric_value()—Set numeric information for a secure session or an SSL environment” on page 28—Set numeric information for a secure session or an SSL environment v “gsk_environment_close()—Close an SSL environment” on page 30—Close the SSL environment v “gsk_environment_init()—Initialize an SSL environment” on page 32—Initialize an SSL environment v “gsk_strerror()—Retrieve GSKit runtime error message” on page 62—Retrieve GSK runtime error message API introduced: V5R1 36 System i: Programming Secure Sockets APIs Top | UNIX-Type APIs | APIs by category
gsk_secure_soc_close()—Close a secure session Syntax #include int gsk_secure_soc_close(gsk_handle *my_session_handle); Service Program Name: QSYS/QSOSSLSR Default Public Authority: *USE Threadsafe: Yes The gsk_secure_soc_close() function is used to close a secure session and free all the associated resources for that secure session. Parameters my_session_handle (Input) A pointer to the handle for the secure session to be closed. This handle originated from a call to gsk_secure_soc_open(). Authorities No authorization is required. Return Value gsk_secure_soc_close() returns an integer. Possible values are: [GSK_OK] gsk_secure_soc_close() was successful. [GSK_CLOSE_FAILED] An error occurred during close processing. [GSK_INVALID_HANDLE] The handle specified was not valid. [GSK_ERROR_IO] An error occurred in SSL processing, check the errno value. Error Conditions When the gsk_secure_soc_close() API fails with return code [GSK_ERROR_IO], errno can be set to: [EINTR] [EDEADLK] [ETERM] Interrupted function call. Resource deadlock avoided. 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. Secure Sockets APIs 37
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 12 and 13: ufID (Input) The following values c
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 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?