io.javadog.cws.api.common

Enum CredentialType

java.lang.Object

java.lang.Enum<CredentialType>

io.javadog.cws.api.common.CredentialType

All Implemented Interfaces:

Serializable, Comparable<CredentialType>

public enum CredentialType
extends Enum<CredentialType>

This is the types of credentials allowed for the Authentication Process. It can be either an Invitation (Signature, with a shared secret). Or it can be a Passphrase, which together a System & Account Salt.

Regardless of the type, the information given will be used to decrypt the Asymmetric Key, which was generated and stored with the Account. The Private part of the Key is encrypted using the credentials, and the Public part of the Key is stored as is, so it can be used by others for encryption.

Since:

CWS 1.0

Author:

Kim Jensen

Enum Constant Summary

Enum Constants

Enum Constant and Description
PASSPHRASE If the Passphrase is chosen, then the information will be used together with both an Account and a System specific Salt to create enough entropy to generate a Symmetric key which can be used to unlock the Asymmetric Key for the Account.
SESSION For websites, where members have a session, this can be added to the CWS for convenience - and also to prevent that a member must continuously provide the login credentials.
SIGNATURE If the Signature is chosen, it is because a Member has been invited to create their own Account.

Method Summary

Modifier and Type	Method and Description
static CredentialType	valueOf(String name) Returns the enum constant of this type with the specified name.
static CredentialType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PASSPHRASE

public static final CredentialType PASSPHRASE

If the Passphrase is chosen, then the information will be used together with both an Account and a System specific Salt to create enough entropy to generate a Symmetric key which can be used to unlock the Asymmetric Key for the Account.

SESSION

public static final CredentialType SESSION

For websites, where members have a session, this can be added to the CWS for convenience - and also to prevent that a member must continuously provide the login credentials. It also helps preventing that websites have to store users credentials alongside a session. Sessions have a pre-defined maximum life-time, after which a Session is considered dead and attempts to use it after this point will lead to a user error.

If a session is used, then the credentials will hold the user session while the accountName is omitted.

SIGNATURE

public static final CredentialType SIGNATURE

If the Signature is chosen, it is because a Member has been invited to create their own Account. The Signature is provided by the System Administrator to the potential Member, who can then create the Account with a higher degree of control over the Credentials.

Method Detail

values

public static CredentialType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CredentialType c : CredentialType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CredentialType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null