System i: Programming Secure Sockets APIs - IBM

More documents

Recommendations

Info

Related Information v “SSL_Create()—Enable SSL Support for the Specified Socket Descriptor” on page 69—Enable SSL Support for the Specified Socket Descriptor v “SSL_Handshake()—Initiate the SSL Handshake Protocol”—Initiate the SSL Handshake Protocol v “SSL_Init()—Initialize the Current Job for SSL” on page 80—Initialize the Current Job for SSL v “SSL_Read()—Receive Data from an SSL-Enabled Socket Descriptor” on page 91—Receive Data from an SSL-Enabled Socket Descriptor v “SSL_Write()—Write Data to an SSL-Enabled Socket Descriptor” on page 97—Write Data to an SSL-Enabled Socket Descriptor API introduced: V4R3 Top | UNIX-Type APIs | APIs by category SSL_Handshake()—Initiate the SSL Handshake Protocol Syntax #include int SSL_Handshake(SSLHandle* handle, int how) Service Program Name: QSOSSLSR Default Public Authority: *USE Threadsafe: Yes The SSL_Handshake() function is used by a program to initiate the SSL handshake protocol. Both the client and the server program must call the SSL_Handshake verb in order to initiate the handshake processing. Parameters SSLHandle* handle (input/output) The pointer to an SSLHandle for an SSL session. An SSLHandle is a typedef for a buffer of type struct SSLHandleStr. In , struct SSLHandleStr is defined as the following: struct SSLHandleStr { /* SSLHandleStr */ int fd; /* Socket descriptor */ int createFlags; /* SSL_Create flags value */ unsigned protocol; /* SSL protocol version */ unsigned timeout; /* Timeout value in seconds */ unsigned char cipherKind[3]; /* Current 2.0 cipher suite */ unsigned short int cipherSuite; /* Current 3.0 cipher suite */ unsigned short int* cipherSuiteList; /* List of cipher suites */ unsigned int cipherSuiteListLen; /* Number of entries in the cipher suites list */ unsigned char* peerCert; /* Peer certificate */ unsigned peerCertLen; /* Peer certificate length */ int peerCertValidateRc; /* Return code from validation of certficate */ int (*exitPgm)(struct SSLHandleStr* sslh); /* Authentication exit 74 System i: Programming Secure Sockets APIs
}; program called when a certificate is received during SSL handshake */ The fields within the SSLHandle structure as pointed to by handle are defined as follows: int fd (input) The socket descriptor of the connection for which the SSL handshake protocol is to be performed. This field was initialized by a prior SSL_Create() API. int createFlags (input) Whether or not the SSL protocol is to be used. If the field specifies a value that does not include the SSL_ENCRYPT flag, then this function will return success without performing the SSL handshake protocol. This field was initialized by a prior SSL_Create() API. unsigned int protocol (input/output) The type of SSL handshake protocol to be performed. The protocol(s) that are acceptable as the handshake protocol for this job. The following values may be specified for protocol and are defined in . SSL_VERSION_CURRENT 0 (TLS with SSL Version 3.0 and SSL Version 2.0 compatibility) SSL_VERSION_2 2 (SSL Version 2.0 only) SSL_VERSION_3 3 (SSL Version 3.0 only) TLS_VERSION_1 4 (TLS Version 1 only) TLSV1_SSLV3 5 (TLS Version 1 with SSL Version 3.0 compatibility) unsigned timeout (input) Upon return, this field will be set to reflect the protocol version actually negotiated. If the createFlags field specifies a value that does not include the SSL_ENCRYPT flag, then this field will be unchanged from its input value. The approximate number of seconds to wait for the SSL handshake protocol to complete. A value of 0 indicates to wait forever for the handshake to complete. unsigned char cipherKind[3] The cipher kind (which is the SSL Version 2.0 cipher suite) negotiated by the (output) handshake. unsigned short int cipherSuite (output) The cipher suite type negotiated by the handshake. unsigned short int* cipherSuiteList (input) A pointer to a cipher specification list that is to be used during the handshake negotiation for this SSL session. This list is a string of concatenated cipher specification values. Each cipher specification is an unsigned short integer value. Any value provided will override, for this SSL session, the default cipher specification list provided by a previous SSL_Init() API or SSL_Init_Application() API . The valid cipher suites allowed are defined in . A value of NULL indicates one of the following: v Use the cipher specification list provided by a previous SSL_Init(), QlgSSL_Init() or SSL_Init_Application() API call. v Use the system default cipher specification list if the previous SSL_Init(), QlgSSL_Init() or SSL_Init_Application() API call did not provide a cipher specification list. 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. The Display System Value (DSPSYSVAL) command or the Retrieve System Values (QWCRSVAL) API can be used to determine the current setting of the supported ciphers (QSSLCSL) for system SSL. Secure Sockets APIs 75
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 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 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 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 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?