dom/webauthn/PWebAuthnTransaction.ipdl
author Mike Shal <mshal@mozilla.com>
Thu, 24 May 2018 14:53:15 -0400
changeset 419942 279077192f944954caeb9d122228bc130217a7c1
parent 407538 8d91193cd766a4dfda888de34792389601d2d6de
child 420502 7a8d360f8c818f8c762f68b795b151db629295a8
permissions -rw-r--r--
Bug 1377524 - Update tup toolchain to v0.7.6; r=chmanchester MozReview-Commit-ID: cdVkPSToXs

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this file,
 * You can obtain one at http://mozilla.org/MPL/2.0/. */

/*
 * IPC Transaction protocol for the WebAuthn DOM API. This IPC protocol allows
 * the content process to call to the parent to access hardware for
 * authentication registration and challenges. All transactions start in the
 * child process, and the parent replies with a "Confirm*" message, or a
 * "Cancel" message if there was an error (no hardware available, no registered
 * keys, etc) or interruption (another transaction was started in another
 * content process). Similarly, the content process can also request a cancel,
 * either triggered explicitly by the user/script or due to UI events like
 * selecting a different tab.
 */

include protocol PBackground;

namespace mozilla {
namespace dom {

struct WebAuthnAuthenticatorSelection {
  bool requireResidentKey;
  bool requireUserVerification;
  bool requirePlatformAttachment;
};

struct WebAuthnScopedCredential {
  uint8_t[] id;
  uint8_t transports;
};

struct WebAuthnExtensionAppId {
  uint8_t[] AppId;
};

union WebAuthnExtension {
  WebAuthnExtensionAppId;
};

struct WebAuthnExtensionResultAppId {
  bool AppId;
};

union WebAuthnExtensionResult {
  WebAuthnExtensionResultAppId;
};

struct WebAuthnMakeCredentialInfo {
  nsString Origin;
  uint8_t[] RpIdHash;
  uint8_t[] ClientDataHash;
  uint32_t TimeoutMS;
  WebAuthnScopedCredential[] ExcludeList;
  WebAuthnExtension[] Extensions;
  WebAuthnAuthenticatorSelection AuthenticatorSelection;
  bool RequestDirectAttestation;
};

struct WebAuthnMakeCredentialResult {
  uint8_t[] RegBuffer;
  bool DirectAttestationPermitted;
};

struct WebAuthnGetAssertionInfo {
  nsString Origin;
  uint8_t[] RpIdHash;
  uint8_t[] ClientDataHash;
  uint32_t TimeoutMS;
  WebAuthnScopedCredential[] AllowList;
  bool RequireUserVerification;
  WebAuthnExtension[] Extensions;
};

struct WebAuthnGetAssertionResult {
  uint8_t[] RpIdHash;
  uint8_t[] CredentialID;
  uint8_t[] SigBuffer;
  WebAuthnExtensionResult[] Extensions;
};

async protocol PWebAuthnTransaction {
  manager PBackground;

  parent:
    async RequestRegister(uint64_t aTransactionId, WebAuthnMakeCredentialInfo aTransactionInfo);
    async RequestSign(uint64_t aTransactionId, WebAuthnGetAssertionInfo aTransactionInfo);
    async RequestCancel(uint64_t aTransactionId);
    async DestroyMe();

  child:
    async __delete__();
    async ConfirmRegister(uint64_t aTransactionId, WebAuthnMakeCredentialResult aResult);
    async ConfirmSign(uint64_t aTransactionId, WebAuthnGetAssertionResult aResult);
    async Abort(uint64_t aTransactionId, nsresult Error);
};

}
}