System i: Programming Secure Sockets APIs - IBM
System i: Programming Secure Sockets APIs - IBM
System i: Programming Secure Sockets APIs - IBM
You also want an ePaper? Increase the reach of your titles
YUMPU automatically turns print PDFs into web optimized ePapers that Google loves.
Contents<br />
<strong>Secure</strong> <strong>Sockets</strong> <strong>APIs</strong> . . . . . . . . . 1<br />
<strong>APIs</strong> . . . . . . . . . . . . . . . . .2<br />
i5/OS Global <strong>Secure</strong> Toolkit (GSKit) <strong>APIs</strong> . . . . .2<br />
gsk_attribute_get_buffer()—Get character information<br />
about a secure session or an SSL environment . . .3<br />
Parameters . . . . . . . . . . . . . .3<br />
Authorities . . . . . . . . . . . . . .4<br />
Return Value . . . . . . . . . . . . .4<br />
Error Conditions . . . . . . . . . . . .5<br />
Usage Notes . . . . . . . . . . . . .5<br />
Related Information . . . . . . . . . . .6<br />
gsk_attribute_get_cert_info()—Get information about<br />
a local or partner certificate . . . . . . . . .6<br />
Parameters . . . . . . . . . . . . . .7<br />
Authorities . . . . . . . . . . . . . .7<br />
Return Value . . . . . . . . . . . . .7<br />
Error Conditions . . . . . . . . . . . .8<br />
Usage Notes . . . . . . . . . . . . .8<br />
Related Information . . . . . . . . . . .9<br />
gsk_attribute_get_enum()—Get enumerated<br />
information about a secure session or an SSL<br />
environment . . . . . . . . . . . . . .10<br />
Parameters . . . . . . . . . . . . .10<br />
Authorities . . . . . . . . . . . . .12<br />
Return Value . . . . . . . . . . . . .12<br />
Error Conditions . . . . . . . . . . . .12<br />
Usage Notes . . . . . . . . . . . . .13<br />
Related Information . . . . . . . . . .13<br />
gsk_attribute_get_numeric_value()—Get numeric<br />
information about a secure session or an SSL<br />
environment . . . . . . . . . . . . . .14<br />
Parameters . . . . . . . . . . . . .14<br />
Authorities . . . . . . . . . . . . .14<br />
Return Value . . . . . . . . . . . . .15<br />
Error Conditions . . . . . . . . . . . .15<br />
Usage Notes . . . . . . . . . . . . .15<br />
Related Information . . . . . . . . . .16<br />
gsk_attribute_set_buffer()—Set character information<br />
for a secure session or an SSL environment . . . .16<br />
Parameters . . . . . . . . . . . . .17<br />
Authorities . . . . . . . . . . . . .17<br />
Return Value . . . . . . . . . . . . .17<br />
Error Conditions . . . . . . . . . . . .18<br />
Usage Notes . . . . . . . . . . . . .18<br />
Related Information . . . . . . . . . .20<br />
gsk_attribute_set_callback()—Set callback pointers to<br />
routines in the user application . . . . . . . .20<br />
Parameters . . . . . . . . . . . . .20<br />
Authorities . . . . . . . . . . . . .22<br />
Return Value . . . . . . . . . . . . .22<br />
Error Conditions . . . . . . . . . . . .23<br />
Usage Notes . . . . . . . . . . . . .23<br />
Related Information . . . . . . . . . .23<br />
gsk_attribute_set_enum()—Set enumerated<br />
information for a secure session or an SSL<br />
environment . . . . . . . . . . . . . .24<br />
Parameters . . . . . . . . . . . . .24<br />
Authorities . . . . . . . . . . . . .26<br />
Return Value . . . . . . . . . . . . .26<br />
Error Conditions . . . . . . . . . . . .26<br />
Usage Notes . . . . . . . . . . . . .27<br />
Related Information . . . . . . . . . .27<br />
gsk_attribute_set_numeric_value()—Set numeric<br />
information for a secure session or an SSL<br />
environment . . . . . . . . . . . . . .28<br />
Parameters . . . . . . . . . . . . .28<br />
Authorities . . . . . . . . . . . . .28<br />
Return Value . . . . . . . . . . . . .28<br />
Error Conditions . . . . . . . . . . . .29<br />
Usage Notes . . . . . . . . . . . . .29<br />
Related Information . . . . . . . . . .30<br />
gsk_environment_close()—Close an SSL<br />
environment . . . . . . . . . . . . . .30<br />
Parameters . . . . . . . . . . . . .30<br />
Authorities . . . . . . . . . . . . .30<br />
Return Value . . . . . . . . . . . . .31<br />
Error Conditions . . . . . . . . . . . .31<br />
Error Messages . . . . . . . . . . . .31<br />
Usage Notes . . . . . . . . . . . . .31<br />
Related Information . . . . . . . . . .31<br />
gsk_environment_init()—Initialize an SSL<br />
environment . . . . . . . . . . . . . .32<br />
Parameters . . . . . . . . . . . . .32<br />
Authorities . . . . . . . . . . . . .32<br />
Return Value . . . . . . . . . . . . .32<br />
Error Conditions . . . . . . . . . . . .33<br />
Error Messages . . . . . . . . . . . .34<br />
Usage Notes . . . . . . . . . . . . .34<br />
Related Information . . . . . . . . . .34<br />
gsk_environment_open()—Get a handle for an SSL<br />
environment . . . . . . . . . . . . . .34<br />
Parameters . . . . . . . . . . . . .35<br />
Authorities . . . . . . . . . . . . .35<br />
Return Value . . . . . . . . . . . . .35<br />
Error Messages . . . . . . . . . . . .35<br />
Usage Notes . . . . . . . . . . . . .35<br />
Related Information . . . . . . . . . .36<br />
gsk_secure_soc_close()—Close a secure session . .37<br />
Parameters . . . . . . . . . . . . .37<br />
Authorities . . . . . . . . . . . . .37<br />
Return Value . . . . . . . . . . . . .37<br />
Error Conditions . . . . . . . . . . . .37<br />
Error Messages . . . . . . . . . . . .38<br />
Usage Notes . . . . . . . . . . . . .38<br />
Related Information . . . . . . . . . .38<br />
gsk_secure_soc_init()—Negotiate a secure session . .38<br />
Parameters . . . . . . . . . . . . .38<br />
Authorities . . . . . . . . . . . . .38<br />
Return Value . . . . . . . . . . . . .38<br />
Error Conditions . . . . . . . . . . . .40<br />
Usage Notes . . . . . . . . . . . . .40<br />
Error Messages . . . . . . . . . . . .40<br />
© Copyright <strong>IBM</strong> Corp. 1998, 2008 iii