Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: xml :: crypto ::

interface XSecurityEnvironment
Description
* Interface of Security Environment

Methods' Summary
getPersonalCertificates * Get personal certificate from the environment  
getCertificate * Get certificate from the environment by issuer name and serial number  
buildCertificatePath * build certificate path from a certain certificate  
createCertificateFromRaw * Create certificate interface from raw DER encoded certificate  
createCertificateFromAscii * Create certificate interface from a BASE64 encoded certificate.  
verifyCertificate Verify a certificate. The method provides a way to verify a certificate.  
getCertificateCharacters * Get a certificate characters. * * The method provides a way to get certificate characters like: * 1. Whether or not the certificate have a private key in the user profile. * 2. Whether or not the certificate is a trusted certificate. * 3. Whether or not the certificate is a self-signed certificate. * * The certificate characters is defined as bit-wise long, please refer to * CertificateCharacters definition.  
getSecurityEnvironmentInformation * Get the Environment detail infos  
Methods' Details
getPersonalCertificates
sequence< ::com::sun::star::security::XCertificate >
getPersonalCertificates()
raises( ::com::sun::star::uno::SecurityException );

Description
* Get personal certificate from the environment
getCertificate
::com::sun::star::security::XCertificate
getCertificate( [in] string  issuerName,
[in] sequence< byte >  serialNumber )
raises( ::com::sun::star::uno::SecurityException );

Description
* Get certificate from the environment by issuer name and serial number
buildCertificatePath
sequence< ::com::sun::star::security::XCertificate >
buildCertificatePath( [in] ::com::sun::star::security::XCertificate  beginCert )
raises( ::com::sun::star::uno::SecurityException );

Description
* build certificate path from a certain certificate
createCertificateFromRaw
::com::sun::star::security::XCertificate
createCertificateFromRaw( [in] sequence< byte >  rawCertificate )
raises( ::com::sun::star::uno::SecurityException );

Description
* Create certificate interface from raw DER encoded certificate
createCertificateFromAscii
::com::sun::star::security::XCertificate
createCertificateFromAscii( [in] string  asciiCertificate )
raises( ::com::sun::star::uno::SecurityException );

Description
* Create certificate interface from a BASE64 encoded certificate.
verifyCertificate
long
verifyCertificate( [in] ::com::sun::star::security::XCertificate  xEECertificate,
[in] sequence< ::com::sun::star::security::XCertificate >  intermediateCertificates )
raises( ::com::sun::star::uno::SecurityException );

Description
Verify a certificate. The method provides a way to verify a certificate.
Parameter xEECertificate
The certificate which is to be validated.
Parameter intermediateCertificates
Additional certificates which can be used by the method in constructing the certificate chain. The root certificate may also be contained. However, the implementation must check if the root certificate is indeed trusted by the user. All entries of the sequence must be non-null references.
Returns
The validation status will returned as a bit-wise long, please refer to CertificateValidity definition.
getCertificateCharacters
long
getCertificateCharacters( [in] ::com::sun::star::security::XCertificate  xCertificate )
raises( ::com::sun::star::uno::SecurityException );

Description
* Get a certificate characters. * * The method provides a way to get certificate characters like: * 1. Whether or not the certificate have a private key in the user profile. * 2. Whether or not the certificate is a trusted certificate. * 3. Whether or not the certificate is a self-signed certificate. * * The certificate characters is defined as bit-wise long, please refer to * CertificateCharacters definition.
getSecurityEnvironmentInformation
string
getSecurityEnvironmentInformation();

Description
* Get the Environment detail infos
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.