Since: Knox API Level 12
public class

CEPConstants

extends Object
java.lang.Object
   ↳ com.samsung.android.knox.keystore.CEPConstants

Class Overview

This class contains all required constant values which are used inside Certificate Enrollment service.

Since
API level 12
KNOX 2.1

Summary

Constants
String CEP_ACTION_CERT_ENROLL_STATUS This broadcast is sent to inform caller about status of Certificate Enrollment request.
String CEP_ACTION_SERVICE_DISCONNECTED This broadcast is sent when the Certificate Enrollment service is uninstalled, stopped or de-activated as an admin.
String CEP_KEYALGO_TYPE_RSA Certificate Key pair Algorithm type for RSA.
String CEP_KEYSTORETYPE_ANDROID Keystore type constant for Android Keystore.
String CEP_KEYSTORETYPE_CCM Keystore type constant for CCM.
String CEP_KEYSTORETYPE_UCM Keystore Type constant for UCM.
int CEP_TLV_CLEAR_CHALLENGE_PASSWORD TLV type which tells that message is a clear text password.
int CEP_TLV_ENCRYPTED_CHALLENGE_PASSWORD TLV type which tells that message is an encrypted challenge password.
int CEP_TLV_ENCRYPTED_DATA TLV type which tells that message is an encrypted data.
int CEP_TLV_ENCRYPTED_KEY TLV type which tells that message is an encrypted AES key.
String CERT_PROFILE_TYPE_CMC Certificate Enrollment protocol is CMC.
String CERT_PROFILE_TYPE_CMP Certificate Enrollment protocol is CMP.
String CERT_PROFILE_TYPE_SCEP Certificate Enrollment protocol is SCEP.
int CERT_SUCCESS Success status for the operations enrollUserCertificate(EnrollmentProfile, List, String), renewUserCertificate(String, List), deleteUserCertificate(String) and getCertEnrollmentStatus(String)
int ERROR_ALIAS_EXIST Error code occurs when user tries to install a certificate with already existing alias.
int ERROR_CCM CCM related error for the operations enrollUserCertificate(EnrollmentProfile, List, String) and renewUserCertificate(String, List).
int ERROR_CCM_NOT_SUPPORTED CCM Keystore is not supported.
int ERROR_CERT_FAILURE Failure status for the operations enrollUserCertificate(EnrollmentProfile, List, String), renewUserCertificate(String, List), deleteUserCertificate(String) and getCertEnrollmentStatus(String)
int ERROR_CERT_NOT_FOUND Crypto error code for certificate not found in the keystore.
int ERROR_CERT_PENDING Indicates pending status of certificate during enroll request.
int ERROR_CERT_VERIFICATION_FAILURE Crypto error code when certificate verification fails while doing Certificate Enrollment Protocol operations.
int ERROR_CHALLENGE_PASSWORD_EXPIRED Code for expiration of the challenge password for the operation enrollUserCertificate(EnrollmentProfile, List, String).
int ERROR_INVALID_CA_CERT Invalid CA certificate for operation enrollUserCertificate(EnrollmentProfile, List, String).
int ERROR_KEYLOCK_NOT_SET Keystore is not initialized or it is locked.
int ERROR_KEYSTORE_EXCEPTION Keystore exception for Certificate Enrollment Protocol operations.
int ERROR_MISSING_INPUTFIELDS Error code for missing input fields.
int ERROR_NETWORK_UNAVAILABLE Network related error for the operations enrollUserCertificate(EnrollmentProfile, List, String) and renewUserCertificate(String, List)
int ERROR_OPERATION_NOT_SUPPORTED Error code for operation not supported by Certificate Enrollment service.
int ERROR_SERVICE_BIND_FAILED Error in binding to Certificate Enrollment service.
int ERROR_TLV_DECODE_FAILURE Failure status for TLV decoding of challenge password for the operation enrollUserCertificate(EnrollmentProfile, List, String).
int ERROR_TRANSACTIONID_NOTFOUND Transaction Id not found error for the operation getCertEnrollmentStatus(String) .
int ERROR_UCM Error code occurs when UCM framework fails to finish a task
int ERROR_UCM_INPUT_INVALID Error code occurs when inputs for UCM are invalid
int ERROR_UNKNOWN Unknown error for the operations enrollUserCertificate(EnrollmentProfile, List, String) and renewUserCertificate(String, List)
String EXTRA_ENROLL_ALIAS Used as string extra field with CEP_ACTION_CERT_ENROLL_STATUS.
String EXTRA_ENROLL_CERT_HASH Used as string extra field with CEP_ACTION_CERT_ENROLL_STATUS.
String EXTRA_ENROLL_REFERENCE_NUMBER Used as string extra field with CEP_ACTION_CERT_ENROLL_STATUS.
String EXTRA_ENROLL_STATUS Used as string extra field with CEP_ACTION_CERT_ENROLL_STATUS.
String EXTRA_ENROLL_TRANSACTION_ID Used as string extra field with CEP_ACTION_CERT_ENROLL_STATUS.
String EXTRA_SERVICE_PROTOCOL Used as string extra field with CEP_ACTION_SERVICE_DISCONNECTED.
String EXTRA_SERVICE_USERID Used as string extra field with CEP_ACTION_CERT_ENROLL_STATUS and CEP_ACTION_SERVICE_DISCONNECTED.
String EXTRA_UCM_CS_MANUFACTURER Used as string extra field for UCM credential storage details This extra specifies the manufacturer of Credential Storage to be used/accessed.
String EXTRA_UCM_CS_NAME Used as string extra field for UCM credential storage details This extra specifies the name of Credential Storage to be used/accessed.
String EXTRA_UCM_CS_PACKAGENAME Used as string extra field for UCM credential storage details This extra specifies the packagename of Credential Storage to be used/accessed.
int SERVICE_BIND_SUCCESS Successful status while binding to Certificate Enrollment service.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final String CEP_ACTION_CERT_ENROLL_STATUS

Since: Knox API Level 12

This broadcast is sent to inform caller about status of Certificate Enrollment request. This targeted broadcast is sent only to the caller who calls the enrollUserCertificate(EnrollmentProfile, List, String) or renewUserCertificate(String, List). The intent will have the following extra value:
EXTRA_ENROLL_STATUS:
CERT_SUCCESS
ERROR_CERT_FAILURE
ERROR_NETWORK_UNAVAILABLE
ERROR_UNKNOWN
ERROR_CCM

EXTRA_ENROLL_ALIAS:
EXTRA_ENROLL_TRANSACTION_ID:
EXTRA_ENROLL_REFERENCE_NUMBER:
EXTRA_ENROLL_CERT_HASH:
EXTRA_SERVICE_USERID:
EXTRA_SERVICE_PROTOCOL:

Since
API level 12
KNOX 2.1
Constant Value: "com.samsung.android.knox.intent.CEP_CERT_ENROLL_STATUS"

public static final String CEP_ACTION_SERVICE_DISCONNECTED

Since: Knox API Level 12

This broadcast is sent when the Certificate Enrollment service is uninstalled, stopped or de-activated as an admin. This targeted broadcast is sent only to the caller which registers the receiver with the same intent action. The intent will have the following extra value:
EXTRA_SERVICE_USERID:
EXTRA_SERVICE_PROTOCOL:

Since
API level 12
KNOX 2.1
Constant Value: "com.samsung.android.knox.intent.CEP_SERVICE_DISCONNECTED"

public static final String CEP_KEYALGO_TYPE_RSA

Since: Knox API Level 12

Certificate Key pair Algorithm type for RSA.

Since
API level 12
KNOX 2.1
Constant Value: "RSA"

public static final String CEP_KEYSTORETYPE_ANDROID

Since: Knox API Level 12

Keystore type constant for Android Keystore.

Since
API level 12
KNOX 2.1
Constant Value: "ANDROID"

public static final String CEP_KEYSTORETYPE_CCM

Since: Knox API Level 12

Keystore type constant for CCM.

Since
API level 12
KNOX 2.1
Constant Value: "CCM"

public static final String CEP_KEYSTORETYPE_UCM

Since: Knox API Level 20

Keystore Type constant for UCM.

Since
API level 20
KNOX 2.7
Constant Value: "UCM"

public static final int CEP_TLV_CLEAR_CHALLENGE_PASSWORD

Since: Knox API Level 12

TLV type which tells that message is a clear text password. Refer challengePassword for all TLV types.

Since
API level 12
KNOX 2.1
Constant Value: 0 (0x00000000)

public static final int CEP_TLV_ENCRYPTED_CHALLENGE_PASSWORD

Since: Knox API Level 12

TLV type which tells that message is an encrypted challenge password. Refer challengePassword for all TLV types.

Since
API level 12
KNOX 2.1
Constant Value: 1 (0x00000001)

public static final int CEP_TLV_ENCRYPTED_DATA

Since: Knox API Level 12

TLV type which tells that message is an encrypted data. Refer challengePassword for all TLV types.

Since
API level 12
KNOX 2.1
Constant Value: 2 (0x00000002)

public static final int CEP_TLV_ENCRYPTED_KEY

Since: Knox API Level 12

TLV type which tells that message is an encrypted AES key. Refer challengePassword for all TLV types.

Since
API level 12
KNOX 2.1
Constant Value: 3 (0x00000003)

public static final String CERT_PROFILE_TYPE_CMC

Since: Knox API Level 12

Certificate Enrollment protocol is CMC.

Since
API level 12
KNOX 2.1
Constant Value: "CMC"

public static final String CERT_PROFILE_TYPE_CMP

Since: Knox API Level 12

Certificate Enrollment protocol is CMP.

Since
API level 12
KNOX 2.1
Constant Value: "CMP"

public static final String CERT_PROFILE_TYPE_SCEP

Since: Knox API Level 12

Certificate Enrollment protocol is SCEP.

Since
API level 12
KNOX 2.1
Constant Value: "SCEP"

public static final int CERT_SUCCESS

Since: Knox API Level 12
Since
API level 12
KNOX 2.1
Constant Value: 0 (0x00000000)

public static final int ERROR_ALIAS_EXIST

Since: Knox API Level 12

Error code occurs when user tries to install a certificate with already existing alias.

Since
API level 12
KNOX 2.1
Constant Value: -309 (0xfffffecb)

public static final int ERROR_CCM

Since: Knox API Level 12
Since
API level 12
KNOX 2.1
Constant Value: -307 (0xfffffecd)

public static final int ERROR_CCM_NOT_SUPPORTED

Since: Knox API Level 12

CCM Keystore is not supported.

Since
API level 12
KNOX 2.1
Constant Value: -308 (0xfffffecc)

public static final int ERROR_CERT_FAILURE

Since: Knox API Level 12
Since
API level 12
KNOX 2.1
Constant Value: -1 (0xffffffff)

public static final int ERROR_CERT_NOT_FOUND

Since: Knox API Level 12

Crypto error code for certificate not found in the keystore.

Since
API level 12
KNOX 2.1
Constant Value: -400 (0xfffffe70)

public static final int ERROR_CERT_PENDING

Since: Knox API Level 12

Indicates pending status of certificate during enroll request.

Since
API level 12
KNOX 2.1
Constant Value: 1 (0x00000001)

public static final int ERROR_CERT_VERIFICATION_FAILURE

Since: Knox API Level 12

Crypto error code when certificate verification fails while doing Certificate Enrollment Protocol operations.

Since
API level 12
KNOX 2.1
Constant Value: -401 (0xfffffe6f)

public static final int ERROR_CHALLENGE_PASSWORD_EXPIRED

Since: Knox API Level 12

Code for expiration of the challenge password for the operation enrollUserCertificate(EnrollmentProfile, List, String). Refer validitytimeForChallenge

Since
API level 12
KNOX 2.1
Constant Value: -303 (0xfffffed1)

public static final int ERROR_INVALID_CA_CERT

Since: Knox API Level 12

Invalid CA certificate for operation enrollUserCertificate(EnrollmentProfile, List, String).

Since
API level 12
KNOX 2.1
Constant Value: -304 (0xfffffed0)

public static final int ERROR_KEYLOCK_NOT_SET

Since: Knox API Level 12

Keystore is not initialized or it is locked.

Since
API level 12
KNOX 2.1
Constant Value: -504 (0xfffffe08)

public static final int ERROR_KEYSTORE_EXCEPTION

Since: Knox API Level 12

Keystore exception for Certificate Enrollment Protocol operations.

Since
API level 12
KNOX 2.1
Constant Value: -501 (0xfffffe0b)

public static final int ERROR_MISSING_INPUTFIELDS

Since: Knox API Level 12

Error code for missing input fields. It can occur for the following cases:
Missing hash while renewUserCertificate(String, List) or enrollUserCertificate(EnrollmentProfile, List, String)
Missing txnId while getCertEnrollmentStatus(String)
Missing mandatory fields like scepUrl or subjectName

Since
API level 12
KNOX 2.1
Constant Value: -305 (0xfffffecf)

public static final int ERROR_NETWORK_UNAVAILABLE

Since: Knox API Level 12
Since
API level 12
KNOX 2.1
Constant Value: -2 (0xfffffffe)

public static final int ERROR_OPERATION_NOT_SUPPORTED

Since: Knox API Level 12

Error code for operation not supported by Certificate Enrollment service.

Since
API level 12
KNOX 2.1
Constant Value: -602 (0xfffffda6)

public static final int ERROR_SERVICE_BIND_FAILED

Since: Knox API Level 12

Error in binding to Certificate Enrollment service.

Since
API level 12
KNOX 2.1
Constant Value: -601 (0xfffffda7)

public static final int ERROR_TLV_DECODE_FAILURE

Since: Knox API Level 12

Failure status for TLV decoding of challenge password for the operation enrollUserCertificate(EnrollmentProfile, List, String).

Since
API level 12
KNOX 2.1
Constant Value: -301 (0xfffffed3)

public static final int ERROR_TRANSACTIONID_NOTFOUND

Since: Knox API Level 12

Transaction Id not found error for the operation getCertEnrollmentStatus(String) .

Since
API level 12
KNOX 2.1
Constant Value: -306 (0xfffffece)

public static final int ERROR_UCM

Since: Knox API Level 20

Error code occurs when UCM framework fails to finish a task

Since
API level 20
KNOX 2.7
Constant Value: -311 (0xfffffec9)

public static final int ERROR_UCM_INPUT_INVALID

Since: Knox API Level 20

Error code occurs when inputs for UCM are invalid

Since
API level 20
KNOX 2.7
Constant Value: -310 (0xfffffeca)

public static final int ERROR_UNKNOWN

Since: Knox API Level 12
Since
API level 12
KNOX 2.1
Constant Value: -3 (0xfffffffd)

public static final String EXTRA_ENROLL_ALIAS

Since: Knox API Level 12

Used as string extra field with CEP_ACTION_CERT_ENROLL_STATUS. Contains the alias of the certificate used in enrollment request or renewal request.

Since
API level 12
KNOX 2.1
Constant Value: "com.samsung.extra.knox.certenroll.ALIAS"

public static final String EXTRA_ENROLL_CERT_HASH

Since: Knox API Level 12

Used as string extra field with CEP_ACTION_CERT_ENROLL_STATUS. Contains the MD5 hash of the client certificate enrolled or renewed.

Since
API level 12
KNOX 2.1
Constant Value: "com.samsung.extra.knox.certenroll.CERT_HASH"

public static final String EXTRA_ENROLL_REFERENCE_NUMBER

Since: Knox API Level 12

Used as string extra field with CEP_ACTION_CERT_ENROLL_STATUS. Contains the reference number of the Certificate Enrollment request or renewal request.

Since
API level 12
KNOX 2.1
Constant Value: "com.samsung.extra.knox.certenroll.REFERENCE_NUMBER"

public static final String EXTRA_ENROLL_STATUS

Since: Knox API Level 12

Used as string extra field with CEP_ACTION_CERT_ENROLL_STATUS. Contains the result of the Certificate Enrollment request or renewal request.

Since
API level 12
KNOX 2.1
Constant Value: "com.samsung.extra.knox.certenroll.STATUS"

public static final String EXTRA_ENROLL_TRANSACTION_ID

Since: Knox API Level 12

Used as string extra field with CEP_ACTION_CERT_ENROLL_STATUS. Contains the transaction id of the Certificate Enrollment request or renewal request.

Since
API level 12
KNOX 2.1
Constant Value: "com.samsung.extra.knox.certenroll.TRANSACTION_ID"

public static final String EXTRA_SERVICE_PROTOCOL

Since: Knox API Level 12

Used as string extra field with CEP_ACTION_SERVICE_DISCONNECTED. This extra specifies the protocol supported by Certificate Enrollment service.

Since
API level 12
KNOX 2.1
Constant Value: "com.samsung.extra.knox.certenroll.SERVICE_PROTOCOL"

public static final String EXTRA_SERVICE_USERID

Since: Knox API Level 12

Used as string extra field with CEP_ACTION_CERT_ENROLL_STATUS and CEP_ACTION_SERVICE_DISCONNECTED. Contains the container Id of the service. E.g. 0 for same user space as caller or the corresponding container ID.

Since
API level 12
KNOX 2.1
Constant Value: "com.samsung.extra.knox.certenroll.SERVICE_USERID"

public static final String EXTRA_UCM_CS_MANUFACTURER

Since: Knox API Level 20

Used as string extra field for UCM credential storage details This extra specifies the manufacturer of Credential Storage to be used/accessed.

Since
API level 20
KNOX 2.7
Constant Value: "com.sec.enterprise.intent.extra.UCM_CS_MANUFACTURER"

public static final String EXTRA_UCM_CS_NAME

Since: Knox API Level 20

Used as string extra field for UCM credential storage details This extra specifies the name of Credential Storage to be used/accessed.

Since
API level 20
KNOX 2.7
Constant Value: "com.sec.enterprise.intent.extra.UCM_CS_NAME"

public static final String EXTRA_UCM_CS_PACKAGENAME

Since: Knox API Level 20

Used as string extra field for UCM credential storage details This extra specifies the packagename of Credential Storage to be used/accessed.

Since
API level 20
KNOX 2.7
Constant Value: "com.sec.enterprise.intent.extra.UCM_CS_PACKAGENAME"

public static final int SERVICE_BIND_SUCCESS

Since: Knox API Level 12

Successful status while binding to Certificate Enrollment service.

Since
API level 12
KNOX 2.1
Constant Value: -600 (0xfffffda8)