/*
 * Copyright 2004-present the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.security.web.webauthn.api;

import java.io.Serial;
import java.io.Serializable;

/**
 * <a href=
 * "https://www.w3.org/TR/webauthn-3/#enumdef-authenticatortransport">AuthenticatorTransport</a>
 * defines hints as to how clients might communicate with a particular authenticator in
 * order to obtain an assertion for a specific credential.
 *
 * @author Rob Winch
 * @since 6.4
 */
public final class AuthenticatorTransport implements Serializable {

	@Serial
	private static final long serialVersionUID = -5617945441117386982L;

	/**
	 * <a href="https://www.w3.org/TR/webauthn-3/#dom-authenticatortransport-usb">usbc</a>
	 * indicates the respective authenticator can be contacted over removable USB.
	 */
	public static final AuthenticatorTransport USB = new AuthenticatorTransport("usb");

	/**
	 * <a href="https://www.w3.org/TR/webauthn-3/#dom-authenticatortransport-nfc">nfc</a>
	 * indicates the respective authenticator can be contacted over Near Field
	 * Communication (NFC).
	 */
	public static final AuthenticatorTransport NFC = new AuthenticatorTransport("nfc");

	/**
	 * <a href="https://www.w3.org/TR/webauthn-3/#dom-authenticatortransport-ble">ble</a>
	 * Indicates the respective authenticator can be contacted over Bluetooth Smart
	 * (Bluetooth Low Energy / BLE).
	 */
	public static final AuthenticatorTransport BLE = new AuthenticatorTransport("ble");

	/**
	 * <a href=
	 * "https://www.w3.org/TR/webauthn-3/#dom-authenticatortransport-smart-card">smart-card</a>
	 * indicates the respective authenticator can be contacted over ISO/IEC 7816 smart
	 * card with contacts.
	 */
	public static final AuthenticatorTransport SMART_CARD = new AuthenticatorTransport("smart-card");

	/**
	 * <a href=
	 * "https://www.w3.org/TR/webauthn-3/#dom-authenticatortransport-hybrid">hybrid</a>
	 * indicates the respective authenticator can be contacted using a combination of
	 * (often separate) data-transport and proximity mechanisms. This supports, for
	 * example, authentication on a desktop computer using a smartphone.
	 */
	public static final AuthenticatorTransport HYBRID = new AuthenticatorTransport("hybrid");

	/**
	 * <a href=
	 * "https://www.w3.org/TR/webauthn-3/#dom-authenticatortransport-internal">internal</a>
	 * indicates the respective authenticator is contacted using a client device-specific
	 * transport, i.e., it is a platform authenticator. These authenticators are not
	 * removable from the client device.
	 */
	public static final AuthenticatorTransport INTERNAL = new AuthenticatorTransport("internal");

	private final String value;

	AuthenticatorTransport(String value) {
		this.value = value;
	}

	/**
	 * Get's the value.
	 * @return the value.
	 */
	public String getValue() {
		return this.value;
	}

	/**
	 * Gets an instance of {@link AuthenticatorTransport}.
	 * @param value the value of the {@link AuthenticatorTransport}
	 * @return the {@link AuthenticatorTransport}
	 */
	public static AuthenticatorTransport valueOf(String value) {
		switch (value) {
			case "usb":
				return USB;
			case "nfc":
				return NFC;
			case "ble":
				return BLE;
			case "smart-card":
				return SMART_CARD;
			case "hybrid":
				return HYBRID;
			case "internal":
				return INTERNAL;
			default:
				return new AuthenticatorTransport(value);
		}
	}

	public static AuthenticatorTransport[] values() {
		return new AuthenticatorTransport[] { USB, NFC, BLE, HYBRID, INTERNAL };
	}

}
