System i: Programming Secure Sockets APIs - IBM

More documents

Recommendations

Info

Example The following example shows how gsk_strerror() is used. Note: By using the code examples, you agree to the terms of the “Code license and disclaimer information” on page 111. #include #include #include void main() { int rc = GSK_OK; gsk_handle env_handle = NULL; } rc = gsk_environment_open(&env_handle); if (rc != GSK_OK) { printf("gsk_environment_open() failed with rc = %d %s\n", rc,gsk_strerror(rc)); break; } ... API introduced: V5R1 Top | UNIX-Type APIs | APIs by category i5/OS Secure Sockets Layer (SSL_) APIs SSL_ APIs, when used in addition to the existing i5/OS Sockets APIs, provide the functions required for applications to establish secure communications. An application using SSL for secure communications is basically a client/server application written using sockets. i5/OS ® The SSL_ APIs are: v “QlgSSL_Init()—Initialize the Current Job for SSL (using NLS-enabled path name)” on page 65 (Initialize the current job for SSL (using NLS-enabled path name)) is used to establish the SSL security information to be used for all SSL sessions for the current job. v “SSL_Create()—Enable SSL Support for the Specified Socket Descriptor” on page 69 (Enable SSL support for the specified socket descriptor) is used by a program to enable SSL support for the specified socket descriptor. v “SSL_Destroy()—End SSL Support for the Specified SSL Session” on page 71 (End SSL support for the specified SSL session) is used by a program to end SSL support for the specified SSL session. v “SSL_Handshake()—Initiate the SSL Handshake Protocol” on page 74 (Initiate the SSL handshake protocol) 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. v “SSL_Init()—Initialize the Current Job for SSL” on page 80 (Initialize the current job for SSL) is used to establish the SSL security information to be used for all SSL sessions for the current job. v “SSL_Init_Application()—Initialize the Current Job for SSL Processing Based on the Application Identifier” on page 84 (Establish the SSL security information) is used to establish the SSL security information to be used for all SSL sessions for the current job based on the specified application identifier. v “SSL_Perror()—Print SSL Error Message” on page 89 (Print SSL error message) prints an error message to stderr. 64 System i: Programming Secure Sockets APIs
v “SSL_Read()—Receive Data from an SSL-Enabled Socket Descriptor” on page 91 (Receive data from an SSL-enabled socket descriptor) is used by a program to receive data from an SSL-enabled socket descriptor. v “SSL_Strerror()—Retrieve SSL Runtime Error Message” on page 95 (Retrieve SSL runtime error message) is used to retrieve an error message and associated text string which describes an SSL return value. v “SSL_Write()—Write Data to an SSL-Enabled Socket Descriptor” on page 97 (Write data to an SSL-enabled socket descriptor) is used by a program to write data to an SSL-enabled socket descriptor. Note: These functions use header (include) files from the library QSYSINC, which is optionally installable. Make sure QSYSINC is installed on your system before using any of the functions. See “Header Files for UNIX-Type Functions” on page 100 for the file and member name of each header file. See the following examples for more information: v Example: Establishing a secure server with SSL_ APIs v Example: Establishing a secure client with SSL_ APIs Top | UNIX-Type APIs | APIs by category QlgSSL_Init()—Initialize the Current Job for SSL (using NLS-enabled path name) Syntax #include int QlgSSL_Init(QlgSSLInit* init) Service Program Name: *SRVPGM Default Public Authority: *USE Threadsafe: Yes The QlgSSL_Init() function is used to establish the SSL security information to be used for all SSL sessions for the current job. The QlgSSL_Init() API establishes a certificate and private key for use by the handshake protocol processing when acting as a server. The QlgSSL_Init() API establishes a certificate for use by the handshake protocol processing when acting as a client that is connected to a server performing client authentication. Parameters QlgSSLInit * init (input) The pointer to a QlgSSLInit structure. QlgSSLInit is a typedef for a buffer of type struct QlgSSLInitStr. In , struct QlgSSLInitStr is defined as the following: struct QlgSSLInitStr { /* QlgSSLInitStr */ Qlg_Path_Name* keyringFileName; /* Key ring file name */ char* keyringPassword; /* Key ring file password */ unsigned short int* cipherSuiteList; /* List of cipher suites */ unsigned int cipherSuiteListLen; /* number of entries in the cipher suites list */ }; The fields within the QlgSSLInit structure as pointed to by init are defined as follows: Secure Sockets APIs 65
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 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 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?