org.kitteh.irc.client.library.feature.sts

Enum StsClientState

java.lang.Object

java.lang.Enum<StsClientState>

org.kitteh.irc.client.library.feature.sts.StsClientState

All Implemented Interfaces:

Serializable, Comparable<StsClientState>

public enum StsClientState
extends Enum<StsClientState>

Enum to keep track of the STS implementation's state machine.

Enum Constant Summary

Enum Constants

Enum Constant and Description
INVALID_STS_MISSING_ON_RECONNECT An STS policy was present when we connected with the insecure port, but it wasn't there when we connected on the advertised secure port.
NO_STS_PRESENT The CAP LS command gave us back a response, but `sts` wasn't present in the list.
STS_POLICY_CACHED A cached policy was used to force a secure connection.
STS_PRESENT_ALREADY_SECURE We connected and found a valid STS policy, but we were already connected on a secure port so we don't need to reconnect.
STS_PRESENT_CANNOT_CONNECT We connected via an insecure communication means and found an STS policy.
STS_PRESENT_NOW_SECURE We connected over plaintext and found a valid STS policy.
STS_PRESENT_RECONNECTING We connected over an insecure link and found a valid `sts` capability.
UNKNOWN A state is not yet available.

Method Summary

Modifier and Type	Method and Description
static StsClientState	valueOf(String name) Returns the enum constant of this type with the specified name.
static StsClientState[]	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

UNKNOWN

public static final StsClientState UNKNOWN

A state is not yet available. Perhaps the CAP LS command has not yet been issued or the IRCd does not support IRCv3.

NO_STS_PRESENT

public static final StsClientState NO_STS_PRESENT

The CAP LS command gave us back a response, but `sts` wasn't present in the list.

STS_POLICY_CACHED

public static final StsClientState STS_POLICY_CACHED

A cached policy was used to force a secure connection.

STS_PRESENT_RECONNECTING

public static final StsClientState STS_PRESENT_RECONNECTING

We connected over an insecure link and found a valid `sts` capability. Now we're going to reconnect on the specified secure port.

STS_PRESENT_ALREADY_SECURE

public static final StsClientState STS_PRESENT_ALREADY_SECURE

We connected and found a valid STS policy, but we were already connected on a secure port so we don't need to reconnect. We will update the stored policy, though.

STS_PRESENT_NOW_SECURE

public static final StsClientState STS_PRESENT_NOW_SECURE

We connected over plaintext and found a valid STS policy. We reconnected successfully using TLS and verified the policy still exists.

STS_PRESENT_CANNOT_CONNECT

public static final StsClientState STS_PRESENT_CANNOT_CONNECT

We connected via an insecure communication means and found an STS policy. We then tried to establish a secure connection on the advertised port, but couldn't. This could be due to a network issue or a problem validating the provided certificate. The client will stay in this state and it is not possible to bypass.

INVALID_STS_MISSING_ON_RECONNECT

public static final StsClientState INVALID_STS_MISSING_ON_RECONNECT

An STS policy was present when we connected with the insecure port, but it wasn't there when we connected on the advertised secure port. This is indicative of an active MitM or a server misconfiguration and should be investigated.

Method Detail

values

public static StsClientState[] 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 (StsClientState c : StsClientState.values())
    System.out.println(c);

Returns:

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

valueOf

public static StsClientState 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