System i: Programming Secure Sockets APIs - IBM

More documents

Recommendations

Info

API introduced: V5R1 Top | UNIX-Type APIs | APIs by category gsk_attribute_get_numeric_value()—Get numeric information about a secure session or an SSL environment Syntax #include int gsk_attribute_get_numeric_value(gsk_handle my_gsk_handle, GSK_NUM_ID numID, int *numValue); Service Program Name: QSYS/QSOSSLSR Default Public Authority: *USE Threadsafe: Yes The gsk_attribute_get_numeric_value() function is used to obtain specific numeric information about a secure session or an SSL environment. Parameters my_gsk_handle (Input) Indicates one of the following handles: v The handle for the secure session. (my_session_handle) v The handle for the SSL environment. (my_env_handle) numID (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_FD (300) - numValue is a socket descriptor to be used for this secure session. v GSK_V2_SESSION_TIMEOUT (301) - SSL Version 2 session time-out for the environment. numValue must be in the range 0-100 seconds. v GSK_V3_SESSION_TIMEOUT (302) - SSL Version 3 and TLS version 1 session time-out for the environment. numValue must be in the range 0-86400 seconds. v GSK_OS400_READ_TIMEOUT (6993) - The receive time-out for the secure session or the SSL environment. v GSK_CERTIFICATE_VALIDATION_CODE (6996) - The certificate validation return code for the local or peer certificate. v GSK_HANDSHAKE_TIMEOUT (6998) - SSL handshake time-out for the secure session or the SSL environment. numValue (Output) A pointer to an integer containing the value of the requested information. Authorities No authorization is required. 14 System i: Programming Secure Sockets APIs
Return Value gsk_attribute_get_numeric_value() returns an integer. Possible values are: [GSK_OK] gsk_attribute_get_numeric_value() was successful. [GSK_ATTRIBUTE_INVALID_ID] The specified numID was not valid. [GSK_INVALID_HANDLE] The handle specified was not valid. [GSK_OS400_ERROR_INVALID_POINTER] The numValue pointer is not valid. [GSK_ERROR_UNSUPPORTED] The numID is currently not supported. [GSK_ERROR_IO] An error occurred in SSL processing, check the errno value. Error Conditions When the gsk_attribute_get_numeric_value() 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_NUM_ID values may be retrieved from the SSL environment after gsk_environment_open(): v GSK_V2_SESSION_TIMEOUT v GSK_V3_SESSION_TIMEOUT v GSK_HANDSHAKE_TIMEOUT v GSK_OS400_READ_TIMEOUT 2. The following GSK_NUM_ID value may be retrieved from the SSL environment after gsk_environment_init(). v GSK_CERTIFICATE_VALIDATION_CODE - Will return the certificate validation return code for the local certificate. 3. The following GSK_NUM_ID value may be retrieved from each individual secure session after gsk_secure_soc_init(). v GSK_CERTIFICATE_VALIDATION_CODE - Will return the certificate validation return code for the peer’s certificate. 4. The following GSK_NUM_ID values may be retrieved from each individual secure session after gsk_secure_soc_open(). Secure Sockets APIs 15
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 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

You also want an ePaper? Increase the reach of your titles

Delete template?

Save as template?