From 07bb297329b9e9754d09dcb6d70417272a626619 Mon Sep 17 00:00:00 2001 From: Anas Nashif Date: Thu, 22 Nov 2012 10:31:06 -0800 Subject: Imported Upstream version 1.2.14 --- docs/api/xmlsec-mscrypto-x509.html | 370 +++++++++++++++++++++++-------------- 1 file changed, 235 insertions(+), 135 deletions(-) (limited to 'docs/api/xmlsec-mscrypto-x509.html') diff --git a/docs/api/xmlsec-mscrypto-x509.html b/docs/api/xmlsec-mscrypto-x509.html index 1dffe6da..09112731 100644 --- a/docs/api/xmlsec-mscrypto-x509.html +++ b/docs/api/xmlsec-mscrypto-x509.html @@ -87,47 +87,56 @@

x509

-

Name

x509 -- X509 certificates support implementation for MS Crypto.
+

Name

x509 -- X509 certificates support implementation for MS Crypto.

Synopsis

#define             xmlSecMSCryptoKeyDataX509Id
-xmlSecKeyDataIdxmlSecMSCryptoKeyDataX509GetKlass   (void);
-PCCERT_CONTEXTxmlSecMSCryptoKeyDataX509GetKeyCert (xmlSecKeyDataPtr data);
-intxmlSecMSCryptoKeyDataX509AdoptKeyCert
-                                                        (xmlSecKeyDataPtr data,
-                                                         PCCERT_CONTEXT cert);
-intxmlSecMSCryptoKeyDataX509AdoptCert  (xmlSecKeyDataPtr data,
-                                                         PCCERT_CONTEXT cert);
-PCCERT_CONTEXTxmlSecMSCryptoKeyDataX509GetCert    (xmlSecKeyDataPtr data,
-                                                         xmlSecSize pos);
-xmlSecSize          xmlSecMSCryptoKeyDataX509GetCertsSize
-                                                        (xmlSecKeyDataPtr data);
-intxmlSecMSCryptoKeyDataX509AdoptCrl   (xmlSecKeyDataPtr data,
-                                                         PCCRL_CONTEXT crl);
-PCCRL_CONTEXTxmlSecMSCryptoKeyDataX509GetCrl     (xmlSecKeyDataPtr data,
-                                                         xmlSecSize pos);
-xmlSecSize          xmlSecMSCryptoKeyDataX509GetCrlsSize
-                                                        (xmlSecKeyDataPtr data);
+xmlSecKeyDataId     xmlSecMSCryptoKeyDataX509GetKlass   (void);
+PCCERT_CONTEXT      xmlSecMSCryptoKeyDataX509GetKeyCert (xmlSecKeyDataPtr data);
+int                 xmlSecMSCryptoKeyDataX509AdoptKeyCert
+                                                        (xmlSecKeyDataPtr data,
+                                                         PCCERT_CONTEXT cert);
+int                 xmlSecMSCryptoKeyDataX509AdoptCert  (xmlSecKeyDataPtr data,
+                                                         PCCERT_CONTEXT cert);
+PCCERT_CONTEXT      xmlSecMSCryptoKeyDataX509GetCert    (xmlSecKeyDataPtr data,
+                                                         xmlSecSize pos);
+xmlSecSize          xmlSecMSCryptoKeyDataX509GetCertsSize
+                                                        (xmlSecKeyDataPtr data);
+int                 xmlSecMSCryptoKeyDataX509AdoptCrl   (xmlSecKeyDataPtr data,
+                                                         PCCRL_CONTEXT crl);
+PCCRL_CONTEXT       xmlSecMSCryptoKeyDataX509GetCrl     (xmlSecKeyDataPtr data,
+                                                         xmlSecSize pos);
+xmlSecSize          xmlSecMSCryptoKeyDataX509GetCrlsSize
+                                                        (xmlSecKeyDataPtr data);
 #define             xmlSecMSCryptoKeyDataRawX509CertId
-xmlSecKeyDataIdxmlSecMSCryptoKeyDataRawX509CertGetKlass
-                                                        (void);
+xmlSecKeyDataId     xmlSecMSCryptoKeyDataRawX509CertGetKlass
+                                                        (void);
 #define             xmlSecMSCryptoX509StoreId
-xmlSecKeyDataStoreIdxmlSecMSCryptoX509StoreGetKlass   (void);
-intxmlSecMSCryptoX509StoreAdoptCert    (xmlSecKeyDataStorePtr store,
-                                                         PCCERT_CONTEXT cert,
-                                                         xmlSecKeyDataType type);
-intxmlSecMSCryptoX509StoreAdoptKeyStore
-                                                        (xmlSecKeyDataStorePtr store,
-                                                         HCERTSTORE keyStore);
-intxmlSecMSCryptoX509StoreAdoptTrustedStore
-                                                        (xmlSecKeyDataStorePtr store,
-                                                         HCERTSTORE trustedStore);
-intxmlSecMSCryptoX509StoreAdoptUntrustedStore
-                                                        (xmlSecKeyDataStorePtr store,
-                                                         HCERTSTORE untrustedStore);
-voidxmlSecMSCryptoX509StoreEnableSystemTrustedCerts
-                                                        (xmlSecKeyDataStorePtr store,
-                                                         int val);
+xmlSecKeyDataStoreId xmlSecMSCryptoX509StoreGetKlass (void); +PCCERT_CONTEXT xmlSecMSCryptoX509StoreFindCert (xmlSecKeyDataStorePtr store, + xmlChar *subjectName, + xmlChar *issuerName, + xmlChar *issuerSerial, + xmlChar *ski, + xmlSecKeyInfoCtx *keyInfoCtx); +PCCERT_CONTEXT xmlSecMSCryptoX509StoreVerify (xmlSecKeyDataStorePtr store, + HCERTSTORE certs, + xmlSecKeyInfoCtx *keyInfoCtx); +int xmlSecMSCryptoX509StoreAdoptCert (xmlSecKeyDataStorePtr store, + PCCERT_CONTEXT cert, + xmlSecKeyDataType type); +int xmlSecMSCryptoX509StoreAdoptKeyStore + (xmlSecKeyDataStorePtr store, + HCERTSTORE keyStore); +int xmlSecMSCryptoX509StoreAdoptTrustedStore + (xmlSecKeyDataStorePtr store, + HCERTSTORE trustedStore); +int xmlSecMSCryptoX509StoreAdoptUntrustedStore + (xmlSecKeyDataStorePtr store, + HCERTSTORE untrustedStore); +void xmlSecMSCryptoX509StoreEnableSystemTrustedCerts + (xmlSecKeyDataStorePtr store, + int val);

Description

@@ -139,31 +148,34 @@

xmlSecMSCryptoKeyDataX509Id

#define             xmlSecMSCryptoKeyDataX509Id

The MSCrypto X509 data klass.

+

xmlSecMSCryptoKeyDataX509GetKlass ()

-
xmlSecKeyDataId     xmlSecMSCryptoKeyDataX509GetKlass   (void);
+
xmlSecKeyDataId     xmlSecMSCryptoKeyDataX509GetKlass   (void);

The MSCrypto X509 key data klass (http://www.w3.org/TR/xmldsig-core/sec-X509Data).

+

- +
Returns :Returns :

the X509 data klass.

xmlSecMSCryptoKeyDataX509GetKeyCert ()

-
PCCERT_CONTEXT      xmlSecMSCryptoKeyDataX509GetKeyCert (xmlSecKeyDataPtr data);
+
PCCERT_CONTEXT      xmlSecMSCryptoKeyDataX509GetKeyCert (xmlSecKeyDataPtr data);

Gets the certificate from which the key was extracted.

+

- - + + - + @@ -172,22 +184,23 @@ extraction or an error occurs.

xmlSecMSCryptoKeyDataX509AdoptKeyCert ()

-
int                 xmlSecMSCryptoKeyDataX509AdoptKeyCert
-                                                        (xmlSecKeyDataPtr data,
-                                                         PCCERT_CONTEXT cert);
+
int                 xmlSecMSCryptoKeyDataX509AdoptKeyCert
+                                                        (xmlSecKeyDataPtr data,
+                                                         PCCERT_CONTEXT cert);

Sets the key's certificate in data.

+

data :

the pointer to X509 key data.

data :

the pointer to X509 key data.
Returns :Returns :

the key's certificate or NULL if key data was not used for key extraction or an error occurs.
- - + + - - + + - +
data :

the pointer to X509 key data.

data :

the pointer to X509 key data.
cert :

the pointer to MSCRYPTO X509 certificate.

cert :

the pointer to MSCRYPTO X509 certificate.
Returns :Returns :

0 on success or a negative value if an error occurs.
@@ -195,21 +208,22 @@ extraction or an error occurs.

xmlSecMSCryptoKeyDataX509AdoptCert ()

-
int                 xmlSecMSCryptoKeyDataX509AdoptCert  (xmlSecKeyDataPtr data,
-                                                         PCCERT_CONTEXT cert);
+
int                 xmlSecMSCryptoKeyDataX509AdoptCert  (xmlSecKeyDataPtr data,
+                                                         PCCERT_CONTEXT cert);

Adds certificate to the X509 key data.

+

- - + + - - + + - +
data :

the pointer to X509 key data.

data :

the pointer to X509 key data.
cert :

the pointer to MSCRYPTO X509 certificate.

cert :

the pointer to MSCRYPTO X509 certificate.
Returns :Returns :

0 on success or a negative value if an error occurs.
@@ -217,22 +231,23 @@ extraction or an error occurs.

xmlSecMSCryptoKeyDataX509GetCert ()

-
PCCERT_CONTEXT      xmlSecMSCryptoKeyDataX509GetCert    (xmlSecKeyDataPtr data,
-                                                         xmlSecSize pos);
+
PCCERT_CONTEXT      xmlSecMSCryptoKeyDataX509GetCert    (xmlSecKeyDataPtr data,
+                                                         xmlSecSize pos);

Gets a certificate from X509 key data.

+

- - + + - - + + - - +
data :

the pointer to X509 key data.

data :

the pointer to X509 key data.
pos :

the desired certificate position.

pos :

the desired certificate position.
Returns :

the pointer to certificate or NULL if pos is larger than the +

Returns :

the pointer to certificate or NULL if pos is larger than the number of certificates in data or an error occurs.
@@ -240,17 +255,18 @@ number of certificates in data or an error occurs

xmlSecMSCryptoKeyDataX509GetCertsSize ()

-
xmlSecSize          xmlSecMSCryptoKeyDataX509GetCertsSize
-                                                        (xmlSecKeyDataPtr data);
+
xmlSecSize          xmlSecMSCryptoKeyDataX509GetCertsSize
+                                                        (xmlSecKeyDataPtr data);

Gets the number of certificates in data.

+

- - + + - +
data :

the pointer to X509 key data.

data :

the pointer to X509 key data.
Returns :Returns :

te number of certificates in data.
@@ -258,21 +274,22 @@ number of certificates in data or an error occurs

xmlSecMSCryptoKeyDataX509AdoptCrl ()

-
int                 xmlSecMSCryptoKeyDataX509AdoptCrl   (xmlSecKeyDataPtr data,
-                                                         PCCRL_CONTEXT crl);
+
int                 xmlSecMSCryptoKeyDataX509AdoptCrl   (xmlSecKeyDataPtr data,
+                                                         PCCRL_CONTEXT crl);

Adds CRL to the X509 key data.

+

- - + + - - + + - +
data :

the pointer to X509 key data.

data :

the pointer to X509 key data.
crl :

the pointer to MSCrypto X509 CRL.

crl :

the pointer to MSCrypto X509 CRL.
Returns :Returns :

0 on success or a negative value if an error occurs.
@@ -280,21 +297,22 @@ number of certificates in data or an error occurs

xmlSecMSCryptoKeyDataX509GetCrl ()

-
PCCRL_CONTEXT       xmlSecMSCryptoKeyDataX509GetCrl     (xmlSecKeyDataPtr data,
-                                                         xmlSecSize pos);
+
PCCRL_CONTEXT       xmlSecMSCryptoKeyDataX509GetCrl     (xmlSecKeyDataPtr data,
+                                                         xmlSecSize pos);

Gets a CRL from X509 key data.

+

- - + + - - + + - + @@ -303,17 +321,18 @@ number of CRLs in data or an error occurs.

xmlSecMSCryptoKeyDataX509GetCrlsSize ()

-
xmlSecSize          xmlSecMSCryptoKeyDataX509GetCrlsSize
-                                                        (xmlSecKeyDataPtr data);
+
xmlSecSize          xmlSecMSCryptoKeyDataX509GetCrlsSize
+                                                        (xmlSecKeyDataPtr data);

Gets the number of CRLs in data.

+

data :

the pointer to X509 key data.

data :

the pointer to X509 key data.
pos :

the desired CRL position.

pos :

the desired CRL position.
Returns :Returns :

the pointer to CRL or NULL if pos is larger than the number of CRLs in data or an error occurs.
- - + + - +
data :

the pointer to X509 key data.

data :

the pointer to X509 key data.
Returns :Returns :

te number of CRLs in data.
@@ -323,16 +342,18 @@ number of CRLs in data or an error occurs.

xmlSecMSCryptoKeyDataRawX509CertId

#define             xmlSecMSCryptoKeyDataRawX509CertId

The MSCrypto raw X509 certificate klass.

+

xmlSecMSCryptoKeyDataRawX509CertGetKlass ()

-
xmlSecKeyDataId     xmlSecMSCryptoKeyDataRawX509CertGetKlass
-                                                        (void);
+
xmlSecKeyDataId     xmlSecMSCryptoKeyDataRawX509CertGetKlass
+                                                        (void);

The raw X509 certificates key data klass.

+

- +
Returns :Returns :

raw X509 certificates key data klass.
@@ -341,41 +362,116 @@ number of CRLs in data or an error occurs.

xmlSecMSCryptoX509StoreId

#define             xmlSecMSCryptoX509StoreId

The MSCrypto X509 store klass.

+

xmlSecMSCryptoX509StoreGetKlass ()

-
xmlSecKeyDataStoreId  xmlSecMSCryptoX509StoreGetKlass   (void);
+
xmlSecKeyDataStoreId  xmlSecMSCryptoX509StoreGetKlass   (void);

The MSCrypto X509 certificates key data store klass.

+

- +
Returns :Returns :

pointer to MSCrypto X509 certificates key data store klass.
+

xmlSecMSCryptoX509StoreFindCert ()

+
PCCERT_CONTEXT      xmlSecMSCryptoX509StoreFindCert     (xmlSecKeyDataStorePtr store,
+                                                         xmlChar *subjectName,
+                                                         xmlChar *issuerName,
+                                                         xmlChar *issuerSerial,
+                                                         xmlChar *ski,
+                                                         xmlSecKeyInfoCtx *keyInfoCtx);
+

Searches store for a certificate that matches given criteria.

+

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
store :

the pointer to X509 key data store klass.

subjectName :

the desired certificate name.

issuerName :

the desired certificate issuer name.

issuerSerial :

the desired certificate issuer serial number.

ski :

the desired certificate SKI.

keyInfoCtx :

the pointer to <dsig:KeyInfo/> element processing context.

Returns :

pointer to found certificate or NULL if certificate is not found +or an error occurs.

+
+
+
+

xmlSecMSCryptoX509StoreVerify ()

+
PCCERT_CONTEXT      xmlSecMSCryptoX509StoreVerify       (xmlSecKeyDataStorePtr store,
+                                                         HCERTSTORE certs,
+                                                         xmlSecKeyInfoCtx *keyInfoCtx);
+

Verifies certs list.

+

+

+ + + + + + + + + + + + + + + + + +
store :

the pointer to X509 certificate context store klass.

certs :

the untrusted certificates stack.

keyInfoCtx :

the pointer to <dsig:KeyInfo/> element processing context.

Returns :

pointer to the first verified certificate from certs.

+
+
+

xmlSecMSCryptoX509StoreAdoptCert ()

-
int                 xmlSecMSCryptoX509StoreAdoptCert    (xmlSecKeyDataStorePtr store,
-                                                         PCCERT_CONTEXT cert,
-                                                         xmlSecKeyDataType type);
+
int                 xmlSecMSCryptoX509StoreAdoptCert    (xmlSecKeyDataStorePtr store,
+                                                         PCCERT_CONTEXT cert,
+                                                         xmlSecKeyDataType type);

Adds trusted (root) or untrusted certificate to the store.

+

- - + + - - + + - - + + - +
store :

the pointer to X509 key data store klass.

store :

the pointer to X509 key data store klass.
cert :

the pointer to PCCERT_CONTEXT X509 certificate.

cert :

the pointer to PCCERT_CONTEXT X509 certificate.
type :

the certificate type (trusted/untrusted).

type :

the certificate type (trusted/untrusted).
Returns :Returns :

0 on success or a negative value if an error occurs.
@@ -383,22 +479,23 @@ number of CRLs in data or an error occurs.

xmlSecMSCryptoX509StoreAdoptKeyStore ()

-
int                 xmlSecMSCryptoX509StoreAdoptKeyStore
-                                                        (xmlSecKeyDataStorePtr store,
-                                                         HCERTSTORE keyStore);
+
int                 xmlSecMSCryptoX509StoreAdoptKeyStore
+                                                        (xmlSecKeyDataStorePtr store,
+                                                         HCERTSTORE keyStore);

Adds keyStore to the list of key stores.

+

- - + + - - + + - +
store :

the pointer to X509 key data store klass.

store :

the pointer to X509 key data store klass.
keyStore :

the pointer to keys store.

keyStore :

the pointer to keys store.
Returns :Returns :

0 on success or a negative value if an error occurs.
@@ -406,22 +503,23 @@ number of CRLs in data or an error occurs.

xmlSecMSCryptoX509StoreAdoptTrustedStore ()

-
int                 xmlSecMSCryptoX509StoreAdoptTrustedStore
-                                                        (xmlSecKeyDataStorePtr store,
-                                                         HCERTSTORE trustedStore);
+
int                 xmlSecMSCryptoX509StoreAdoptTrustedStore
+                                                        (xmlSecKeyDataStorePtr store,
+                                                         HCERTSTORE trustedStore);

Adds trustedStore to the list of trusted certs stores.

+

- - + + - - + + - +
store :

the pointer to X509 key data store klass.

store :

the pointer to X509 key data store klass.
trustedStore :

the pointer to certs store.

trustedStore :

the pointer to certs store.
Returns :Returns :

0 on success or a negative value if an error occurs.
@@ -429,22 +527,23 @@ number of CRLs in data or an error occurs.

xmlSecMSCryptoX509StoreAdoptUntrustedStore ()

-
int                 xmlSecMSCryptoX509StoreAdoptUntrustedStore
-                                                        (xmlSecKeyDataStorePtr store,
-                                                         HCERTSTORE untrustedStore);
+
int                 xmlSecMSCryptoX509StoreAdoptUntrustedStore
+                                                        (xmlSecKeyDataStorePtr store,
+                                                         HCERTSTORE untrustedStore);

Adds trustedStore to the list of un-trusted certs stores.

+

- - + + - - + + - +
store :

the pointer to X509 key data store klass.

store :

the pointer to X509 key data store klass.
untrustedStore :

the pointer to certs store.

untrustedStore :

the pointer to certs store.
Returns :Returns :

0 on success or a negative value if an error occurs.
@@ -452,19 +551,20 @@ number of CRLs in data or an error occurs.

xmlSecMSCryptoX509StoreEnableSystemTrustedCerts ()

-
void                xmlSecMSCryptoX509StoreEnableSystemTrustedCerts
-                                                        (xmlSecKeyDataStorePtr store,
-                                                         int val);
+
void                xmlSecMSCryptoX509StoreEnableSystemTrustedCerts
+                                                        (xmlSecKeyDataStorePtr store,
+                                                         int val);

Enables/disables the system trusted certs.

+

- - + + - - + +
store :

the pointer to X509 key data store klass.

store :

the pointer to X509 key data store klass.
val :

the enable/disable flag

val :

the enable/disable flag
-- cgit v1.2.3