| // Copyright 2018 The Chromium Authors. All rights reserved. |
| // Copyright (C) 2018 Apple Inc. All rights reserved. |
| // |
| // Redistribution and use in source and binary forms, with or without |
| // modification, are permitted provided that the following conditions are |
| // met: |
| // |
| // * Redistributions of source code must retain the above copyright |
| // notice, this list of conditions and the following disclaimer. |
| // * Redistributions in binary form must reproduce the above |
| // copyright notice, this list of conditions and the following disclaimer |
| // in the documentation and/or other materials provided with the |
| // distribution. |
| // * Neither the name of Google Inc. nor the names of its |
| // contributors may be used to endorse or promote products derived from |
| // this software without specific prior written permission. |
| // |
| // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| |
| #pragma once |
| |
| #if ENABLE(WEB_AUTHN) |
| |
| #include "CBORValue.h" |
| #include <wtf/Forward.h> |
| |
| namespace fido { |
| |
| // Represents CTAP device properties and capabilities received as a response to |
| // AuthenticatorGetInfo command. |
| class WEBCORE_EXPORT AuthenticatorSupportedOptions { |
| WTF_MAKE_NONCOPYABLE(AuthenticatorSupportedOptions); |
| public: |
| enum class UserVerificationAvailability { |
| // e.g. Authenticator with finger print sensor and user's fingerprint is |
| // registered to the device. |
| kSupportedAndConfigured, |
| // e.g. Authenticator with fingerprint sensor without user's fingerprint |
| // registered. |
| kSupportedButNotConfigured, |
| kNotSupported |
| }; |
| |
| enum class ClientPinAvailability { |
| kSupportedAndPinSet, |
| kSupportedButPinNotSet, |
| kNotSupported, |
| }; |
| |
| AuthenticatorSupportedOptions() = default; |
| AuthenticatorSupportedOptions(AuthenticatorSupportedOptions&&) = default; |
| AuthenticatorSupportedOptions& operator=(AuthenticatorSupportedOptions&&) = default; |
| |
| AuthenticatorSupportedOptions& setIsPlatformDevice(bool); |
| AuthenticatorSupportedOptions& setSupportsResidentKey(bool); |
| AuthenticatorSupportedOptions& setUserVerificationAvailability(UserVerificationAvailability); |
| AuthenticatorSupportedOptions& setUserPresenceRequired(bool); |
| AuthenticatorSupportedOptions& setClientPinAvailability(ClientPinAvailability); |
| |
| bool isPlatformDevice() const { return m_isPlatformDevice; } |
| bool supportsResidentKey() const { return m_supportsResidentKey; } |
| UserVerificationAvailability userVerificationAvailability() const { return m_userVerificationAvailability; } |
| bool userPresenceRequired() const { return m_userPresenceRequired; } |
| ClientPinAvailability clientPinAvailability() const { return m_clientPinAvailability; } |
| |
| private: |
| // Indicates that the device is attached to the client and therefore can't be |
| // removed and used on another client. |
| bool m_isPlatformDevice { false }; |
| // Indicates that the device is capable of storing keys on the device itself |
| // and therefore can satisfy the authenticatorGetAssertion request with |
| // allowList parameter not specified or empty. |
| bool m_supportsResidentKey { false }; |
| // Indicates whether the device is capable of verifying the user on its own. |
| UserVerificationAvailability m_userVerificationAvailability { UserVerificationAvailability::kNotSupported }; |
| bool m_userPresenceRequired { true }; |
| // Represents whether client pin in set and stored in device. Set as null |
| // optional if client pin capability is not supported by the authenticator. |
| ClientPinAvailability m_clientPinAvailability { ClientPinAvailability::kNotSupported }; |
| }; |
| |
| WEBCORE_EXPORT cbor::CBORValue convertToCBOR(const AuthenticatorSupportedOptions&); |
| |
| } // namespace fido |
| |
| #endif // ENABLE(WEB_AUTHN) |