Digital Certificate Management APIs and Exit Programs

The digital certificate management APIs enable X.509 type certificates to be associated with a user profile.

The APIs add, remove, list and find certificates that are associated with user profiles.

This section also includes APIs and exit programs for registering applications that use certificates. Applications that need to use certificates will make themselves known by registering themselves. As part of that registration, applications will identify an exit program that is to be called whenever a certificate is assigned to the application or if the certificate assignment changes. The application is, therefore, not responsible for providing a user interface for certificate management. When the application starts, it can retrieve the name and location of the certificate assigned to the application and use it for initiating a Secure Sockets Layer (SSL) session or some other operation that requires a certificate.

The digital certificate management APIs and their functions follow:

• Add User Certificate (QSYADDUC, QsyAddUserCertificate) associates a certificate with an OS/400 user profile.

• Add Validation List Certificate (QSYADDVC,QsyAddVldlCertificate) adds a certificate to a validation list.

• Check Validation List Certificate (QSYCHKVC, QsyCheckVldlCertificate) determines whether a certificate is in a validation list.

• Deregister Application for Certificate Use (QsyDeregisterAppForCertUse) removes an application and all associated certificate information from the registration facility.

• Find Certificate User QSYFNDCU, QsyFindCertificateUser) finds the user that is associated with a certificate.

• List User Certificates (QSYLSTUC, QsyListUserCertificates) lists the certificates in the user profile.

• List Validation List Certificates (QSYLSTVC, QsyListVldlCertificates) lists the certificates in the validation list.

• Open List of User Certificates (QSYOLUC) provides a list of user certificates associated with a user.

• Parse Certificate (QSYPARSC, QsyParseCertificate) parses a certificate and puts the results in the caller's storage.

• Register Application for Certificate Use (QsyRegisterAppForCertUse) registers an application with the registration facility.

• Remove User Certificate (QSYRMVUC, QsyRemoveUserCertificate) removes a certificate from an OS/400 user profile.

• Remove Validation List Certificate (QSYRMVVC, QsyRemoveVldlCertificate) removes a certificate from a validation list.

The digital certificate management exit programs and their functions follow:

• Deregister Application for Certificate Use is called when an application that uses certificates is deregistered.

• Update Certificate Usage is called when a certificate is updated for an application or removed from an application using Digital Certificate Manager (DCM).