dom/webauthn/PublicKeyCredential.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef mozilla_dom_PublicKeyCredential_h
   8 #define mozilla_dom_PublicKeyCredential_h
   9
  10 #include "js/TypeDecls.h"
  11 #include "mozilla/Attributes.h"
  12 #include "mozilla/dom/AuthenticatorAssertionResponse.h"
  13 #include "mozilla/dom/AuthenticatorAttestationResponse.h"
  14 #include "mozilla/dom/BindingDeclarations.h"
  15 #include "mozilla/dom/Credential.h"
  16 #include "nsCycleCollectionParticipant.h"
  17 #include "nsWrapperCache.h"
  18
  19 namespace mozilla::dom {
  20
  21 class PublicKeyCredential final : public Credential {
  22  public:
  23   NS_DECL_ISUPPORTS_INHERITED
  24   NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS_INHERITED(PublicKeyCredential,
  25                                                          Credential)
  26
  27   explicit PublicKeyCredential(nsPIDOMWindowInner* aParent);
  28
  29  protected:
  30   ~PublicKeyCredential() override;
  31
  32  public:
  33   virtual JSObject* WrapObject(JSContext* aCx,
  34                                JS::Handle<JSObject*> aGivenProto) override;
  35
  36   void GetRawId(JSContext* aCx, JS::MutableHandle<JSObject*> aValue,
  37                 ErrorResult& aRv);
  38
  39   void GetAuthenticatorAttachment(DOMString& aAuthenticatorAttachment);
  40
  41   already_AddRefed<AuthenticatorResponse> Response() const;
  42
  43   void SetRawId(const nsTArray<uint8_t>& aBuffer);
  44
  45   void SetAuthenticatorAttachment(
  46       const Maybe<nsString>& aAuthenticatorAttachment);
  47
  48   void SetAttestationResponse(
  49       const RefPtr<AuthenticatorAttestationResponse>& aAttestationResponse);
  50   void SetAssertionResponse(
  51       const RefPtr<AuthenticatorAssertionResponse>& aAssertionResponse);
  52
  53   static already_AddRefed<Promise>
  54   IsUserVerifyingPlatformAuthenticatorAvailable(GlobalObject& aGlobal,
  55                                                 ErrorResult& aError);
  56
  57   static already_AddRefed<Promise> GetClientCapabilities(GlobalObject& aGlobal,
  58                                                          ErrorResult& aError);
  59
  60   static already_AddRefed<Promise> IsConditionalMediationAvailable(
  61       GlobalObject& aGlobal, ErrorResult& aError);
  62
  63   void GetClientExtensionResults(
  64       JSContext* cx, AuthenticationExtensionsClientOutputs& aResult) const;
  65
  66   void ToJSON(JSContext* aCx, JS::MutableHandle<JSObject*> aRetval,
  67               ErrorResult& aError);
  68
  69   void SetClientExtensionResultAppId(bool aResult);
  70
  71   void SetClientExtensionResultCredPropsRk(bool aResult);
  72
  73   void SetClientExtensionResultHmacSecret(bool aHmacCreateSecret);
  74   void InitClientExtensionResultPrf();
  75   void SetClientExtensionResultPrfEnabled(bool aPrfEnabled);
  76   void SetClientExtensionResultPrfResultsFirst(
  77       const nsTArray<uint8_t>& aPrfResultsFirst);
  78   void SetClientExtensionResultPrfResultsSecond(
  79       const nsTArray<uint8_t>& aPrfResultsSecond);
  80
  81   static void ParseCreationOptionsFromJSON(
  82       GlobalObject& aGlobal,
  83       const PublicKeyCredentialCreationOptionsJSON& aOptions,
  84       PublicKeyCredentialCreationOptions& aResult, ErrorResult& aRv);
  85
  86   static void ParseRequestOptionsFromJSON(
  87       GlobalObject& aGlobal,
  88       const PublicKeyCredentialRequestOptionsJSON& aOptions,
  89       PublicKeyCredentialRequestOptions& aResult, ErrorResult& aRv);
  90
  91  private:
  92   nsTArray<uint8_t> mRawId;
  93   JS::Heap<JSObject*> mRawIdCachedObj;
  94   Maybe<nsString> mAuthenticatorAttachment;
  95   RefPtr<AuthenticatorAttestationResponse> mAttestationResponse;
  96   RefPtr<AuthenticatorAssertionResponse> mAssertionResponse;
  97   AuthenticationExtensionsClientOutputs mClientExtensionOutputs;
  98
  99   // We need a reference to JSContext in order to convert nsTArray to
 100   // BufferSource, so we need to store these outside mClientExtensionOutputs and
 101   // defer the conversion until the GetClientExtensionResults call.
 102   Maybe<nsTArray<uint8_t>> mPrfResultsFirst;
 103   Maybe<nsTArray<uint8_t>> mPrfResultsSecond;
 104 };
 105
 106 }  // namespace mozilla::dom
 107
 108 #endif  // mozilla_dom_PublicKeyCredential_h