com.cloudpos.advance.ext.system.security

Interface IUserCredentials

All Superinterfaces:

IAdvanceDevice

public interface IUserCredentials
extends IAdvanceDevice

Method Summary

Modifier and Type	Method and Description
boolean	clearCredentials() Clears all installed CA certificates and key pairs.
boolean	deleteCaCert(String alias) Deletes a CA certificate associated with the specified alias.
boolean	existCaCert(String alias) Checks whether a CA certificate exists for the specified alias.
boolean	existKeyPair(String alias) Checks whether a key pair exists for the specified alias.
byte[]	getCaCert(String alias) Retrieves the CA certificate associated with the specified alias.
String	installCaCert(byte[] certBuffer) Installs the specified certificate as a user CA certificate.
boolean	installKeyPair(String alias, int type, byte[] priKey, byte[] cert) Installs a certificate and its corresponding private key.
boolean	removeKeyPair(String alias) Removes a certificate and its corresponding private key installed under the specified alias.

Methods inherited from interface com.cloudpos.advance.ext.IAdvanceDevice

close, isOpened, open

Method Detail

clearCredentials

boolean clearCredentials()
                  throws DeviceException

Clears all installed CA certificates and key pairs.

Returns:

true if all private key aliases and certificates have been removed; false otherwise.

Applications must request permission :

 <uses-permission android:name="android.permission.CLOUDPOS_USERCERTIFICATE" /> 

Throws:

DeviceException

deleteCaCert

boolean deleteCaCert(String alias)
              throws DeviceException

Deletes a CA certificate associated with the specified alias.

Parameters:

alias - The alias of the private key under which the certificate was installed.

Returns:

true if the certificate and private key alias no longer exist; false otherwise.

Applications must request permission :

 <uses-permission android:name="android.permission.CLOUDPOS_USERCERTIFICATE" /> 

Throws:

DeviceException

existCaCert

boolean existCaCert(String alias)
             throws DeviceException

Checks whether a CA certificate exists for the specified alias.

Parameters:

alias - The alias of the CA certificate to check.

Returns:

true if a CA certificate exists for the alias; false otherwise.

Applications must request permission :

 <uses-permission android:name="android.permission.CLOUDPOS_USERCERTIFICATE" /> 

Throws:

DeviceException

existKeyPair

boolean existKeyPair(String alias)
              throws DeviceException

Checks whether a key pair exists for the specified alias.

Parameters:

alias - The alias of the key pair to check.

Returns:

true if a key pair exists for the alias; false otherwise.

Applications must request permission :

 <uses-permission android:name="android.permission.CLOUDPOS_USERCERTIFICATE" /> 

Throws:

DeviceException

getCaCert

byte[] getCaCert(String alias)
          throws DeviceException

Retrieves the CA certificate associated with the specified alias.

Parameters:

alias - The alias of the private key under which the certificate was installed.

Returns:

The encoded certificate as a byte array, or null if no certificate exists for the alias.

Applications must request permission :

 <uses-permission android:name="android.permission.CLOUDPOS_USERCERTIFICATE" /> 

Throws:

DeviceException

installCaCert

String installCaCert(byte[] certBuffer)
              throws DeviceException

Installs the specified certificate as a user CA certificate.

Parameters:

certBuffer - The encoded certificate to be installed.(certficate.getEncoded())

Returns:

If the certificate is installed successfully, the ca alias will be returned; if the certificate cannot be parsed or installation was interrupted ，null will be returned .

Applications must request permission :

 <uses-permission android:name="android.permission.CLOUDPOS_USERCERTIFICATE" /> 

Throws:

DeviceException

installKeyPair

boolean installKeyPair(String alias,
                       int type,
                       byte[] priKey,
                       byte[] cert)
                throws DeviceException

Installs a certificate and its corresponding private key. All apps within the profile can access the certificate and private key, but only after direct user approval.

Note: The caller of this API does not automatically gain access to the installed credentials. This restriction ensures that certificates installed by a compromised installer remain protected.

Parameters:

alias - The alias under which the private key and certificate will be installed. If a certificate already exists for this alias, it will be overwritten.

type - Certificate type: 1 for Wi-Fi certificates, 0 for VPN and app user certificates. (Supported only on system versions higher than Android 12.)

priKey - The private key to install.(privatekey.getEncoded())

cert - The certificate to install.(certficate.getEncoded())

Returns:

true if the key pair was successfully installed; false otherwise.

Applications must request permission :

 <uses-permission android:name="android.permission.CLOUDPOS_USERCERTIFICATE" /> 

Throws:

DeviceException

removeKeyPair

boolean removeKeyPair(String alias)
               throws DeviceException

Removes a certificate and its corresponding private key installed under the specified alias.

Parameters:

alias - The alias of the private key and certificate to remove.

Returns:

true if the key pair no longer exists; false otherwise.

Applications must request permission :

 <uses-permission android:name="android.permission.CLOUDPOS_USERCERTIFICATE" /> 

Throws:

DeviceException