net.rim.device.api.crypto.certificate
Class CertificateProperties

java.lang.Object
  net.rim.device.api.crypto.certificate.CertificateProperties

Direct Known Subclasses:

CertificateChainProperties

public class CertificateProperties
extends Object

This class contains constants representing many properties that may pertain to certificates or certificate chains. There are also methods designed to select the "best" set of properties from an array of property values.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.1.0

Field Summary
	static long	IMPROPER_CERTIFICATE_CHAIN A certificate chain property that indicates that there is a problem with the chain (eg the chain violates some path constraints).
	static long	INCOMPLETE_CERTIFICATE_CHAIN A certificate chain property that indicates that the chain does not terminate with a self signed root certificate.
	static long	INVALID_CERTIFICATE_PRESENT A certificate chain property that indicates that at least one certificate in the chain is either not yet valid, or has expired.
	static long	REVOCATION_REASON_AFFILIATION_CHANGED A certificate chain property that indicates that at least one certificate in the chain is revoked.
	protected static long	REVOCATION_REASON_BASE
	static long	REVOCATION_REASON_CA_COMPROMISE A certificate chain property that indicates that at least one certificate in the chain is revoked.
	static long	REVOCATION_REASON_CERTIFICATE_HOLD A certificate chain property that indicates that at least one certificate in the chain is revoked.
	static long	REVOCATION_REASON_CESSATION_OF_OPERATION A certificate chain property that indicates that at least one certificate in the chain is revoked.
	static long	REVOCATION_REASON_KEY_COMPROMISE A certificate chain property that indicates that at least one certificate in the chain is revoked.
	static long	REVOCATION_REASON_KEY_RETIRED A certificate chain property that indicates that at least one certificate in the chain is revoked.
	static long	REVOCATION_REASON_REMOVE_FROM_CRL A certificate chain property that indicates that at least one certificate in the chain is revoked.
	static long	REVOCATION_REASON_SUPERSEDED A certificate chain property that indicates that at least one certificate in the chain is revoked.
	static long	REVOCATION_REASON_UNSPECIFIED A certificate chain property that indicates that at least one certificate in the chain is revoked.
	static long	REVOCATION_REASON_USER_ID_INVALID A certificate chain property that indicates that at least one certificate in the chain is revoked.
	static long	REVOKED_CERTIFICATE_STATUS_PRESENT A certificate chain property that indicates that at least one certificate in the chain is revoked.
	static long	STALE_CERTIFICATE_STATUS A certificate chain property that indicates that at least one certificate in the chain has a stale status.
	static long	UNKNOWN_CERTIFICATE_STATUS_PRESENT A certificate chain property that indicates that at least one certificate in the chain has an unknown certificate revocation status.
	static long	UNSUPPORTED_CERTIFICATE_CHAIN A certificate chain property that indicates that at least one signature in the chain uses an unsupported algorithm.
	static long	UNTRUSTED_CERTIFICATE_CHAIN A certificate chain property that indicates that no certificate in the chain is a member of a trusted key store.
	static long	UNVERIFIED_CERTIFICATE_CHAIN A certificate chain property that indicates that at least one signature in the chain does not verify.
	static long	WEAK_CERTIFICATE_CHAIN A certificate chain property that indicates that at least one signature in the chain was signed with a weak key.
	static long	WEAK_CERTIFICATE_CHAIN_DIGEST A certificate chain property that indicates that at least one signature in the chain was signed with a weak digest.

Constructor Summary
	CertificateProperties() Creates a new CertificateProperties object.

Method Summary
	static int[]	select(long[] properties, long[] propertyMasks) Selects a set of properties based on a provided set of masks.
	static int	selectBest(long[] properties) Returns the index of the best set of properties from the provided array.
	static long	selectBestProperties(long[] properties) Returns the best set of properties from the provided array.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INCOMPLETE_CERTIFICATE_CHAIN

public static final long INCOMPLETE_CERTIFICATE_CHAIN

A certificate chain property that indicates that the chain does not terminate with a self signed root certificate.

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.1.0

UNVERIFIED_CERTIFICATE_CHAIN

public static final long UNVERIFIED_CERTIFICATE_CHAIN

A certificate chain property that indicates that at least one signature in the chain does not verify.

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.1.0

UNSUPPORTED_CERTIFICATE_CHAIN

public static final long UNSUPPORTED_CERTIFICATE_CHAIN

A certificate chain property that indicates that at least one signature in the chain uses an unsupported algorithm.

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.1.0

UNTRUSTED_CERTIFICATE_CHAIN

public static final long UNTRUSTED_CERTIFICATE_CHAIN

A certificate chain property that indicates that no certificate in the chain is a member of a trusted key store.

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.1.0

IMPROPER_CERTIFICATE_CHAIN

public static final long IMPROPER_CERTIFICATE_CHAIN

A certificate chain property that indicates that there is a problem with the chain (eg the chain violates some path constraints).

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.1.0

WEAK_CERTIFICATE_CHAIN

public static final long WEAK_CERTIFICATE_CHAIN

A certificate chain property that indicates that at least one signature in the chain was signed with a weak key.

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.1.0

WEAK_CERTIFICATE_CHAIN_DIGEST

public static final long WEAK_CERTIFICATE_CHAIN_DIGEST

A certificate chain property that indicates that at least one signature in the chain was signed with a weak digest.

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.3.0

INVALID_CERTIFICATE_PRESENT

public static final long INVALID_CERTIFICATE_PRESENT

A certificate chain property that indicates that at least one certificate in the chain is either not yet valid, or has expired.

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.1.0

UNKNOWN_CERTIFICATE_STATUS_PRESENT

public static final long UNKNOWN_CERTIFICATE_STATUS_PRESENT

A certificate chain property that indicates that at least one certificate in the chain has an unknown certificate revocation status.

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.1.0

REVOKED_CERTIFICATE_STATUS_PRESENT

public static final long REVOKED_CERTIFICATE_STATUS_PRESENT

A certificate chain property that indicates that at least one certificate in the chain is revoked.

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.1.0

STALE_CERTIFICATE_STATUS

public static final long STALE_CERTIFICATE_STATUS

A certificate chain property that indicates that at least one certificate in the chain has a stale status.

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.1.0

REVOCATION_REASON_BASE

protected static final long REVOCATION_REASON_BASE

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.1.0

REVOCATION_REASON_UNSPECIFIED

public static final long REVOCATION_REASON_UNSPECIFIED

A certificate chain property that indicates that at least one certificate in the chain is revoked. See also RevocationReason.

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.1.0

REVOCATION_REASON_KEY_COMPROMISE

public static final long REVOCATION_REASON_KEY_COMPROMISE

A certificate chain property that indicates that at least one certificate in the chain is revoked. See also RevocationReason.

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.1.0

REVOCATION_REASON_CA_COMPROMISE

public static final long REVOCATION_REASON_CA_COMPROMISE

A certificate chain property that indicates that at least one certificate in the chain is revoked. See also RevocationReason.

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.1.0

REVOCATION_REASON_AFFILIATION_CHANGED

public static final long REVOCATION_REASON_AFFILIATION_CHANGED

A certificate chain property that indicates that at least one certificate in the chain is revoked. See also RevocationReason.

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.1.0

REVOCATION_REASON_SUPERSEDED

public static final long REVOCATION_REASON_SUPERSEDED

A certificate chain property that indicates that at least one certificate in the chain is revoked. See also RevocationReason.

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.1.0

REVOCATION_REASON_CESSATION_OF_OPERATION

public static final long REVOCATION_REASON_CESSATION_OF_OPERATION

A certificate chain property that indicates that at least one certificate in the chain is revoked. See also RevocationReason.

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.1.0

REVOCATION_REASON_CERTIFICATE_HOLD

public static final long REVOCATION_REASON_CERTIFICATE_HOLD

A certificate chain property that indicates that at least one certificate in the chain is revoked. See also RevocationReason.

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.1.0

REVOCATION_REASON_REMOVE_FROM_CRL

public static final long REVOCATION_REASON_REMOVE_FROM_CRL

A certificate chain property that indicates that at least one certificate in the chain is revoked. See also RevocationReason.

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.1.0

REVOCATION_REASON_KEY_RETIRED

public static final long REVOCATION_REASON_KEY_RETIRED

A certificate chain property that indicates that at least one certificate in the chain is revoked. See also RevocationReason.

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.2.1

REVOCATION_REASON_USER_ID_INVALID

public static final long REVOCATION_REASON_USER_ID_INVALID

A certificate chain property that indicates that at least one certificate in the chain is revoked. See also RevocationReason.

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.2.1

Constructor Detail

CertificateProperties

public CertificateProperties()

Creates a new CertificateProperties object.

This is the default constructor and is not used.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.1.0

Method Detail

selectBestProperties

public static long selectBestProperties(long[] properties)

Returns the best set of properties from the provided array.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.1.0

selectBest

public static int selectBest(long[] properties)

Returns the index of the best set of properties from the provided array.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.1.0

select

public static int[] select(long[] properties,
                           long[] propertyMasks)

Selects a set of properties based on a provided set of masks.

Parameters:

properties - an array of certiticate properties

propertyMasks - an array of certificate property masks

Returns:

an array of two integers (n,m) satisfying the following conditions:

1. Set n only has properties specified in mask m (although it may not have all of the specified properties)
2. There is no n' and no m' < m such that set n' only has properties specified in mask m'.

(In other words, m is the smallest index into the mask array for which there is a property set that only has properties specified in that mask, and n is the index of a property set that has those properties.)

If there is no property set matching any of the property masks, then the array (-1,-1) is returned.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.1.0