CredentialsContainer: create() Methode

options Optional

Ein Objekt, das Optionen für das angeforderte neue Credentials-Objekt enthält. Es kann die folgenden Eigenschaften enthalten:

signal Optional

Eine AbortSignal Objektinstanz, die es ermöglicht, einen laufenden create() Vorgang abzubrechen. Ein abgebrochener Vorgang kann normal abgeschlossen werden (im Allgemeinen, wenn der Abbruch nach Beendigung des Vorgangs empfangen wurde) oder mit einem AbortError DOMException abgelehnt werden.

Jede der folgenden Eigenschaften repräsentiert einen Credential-Typ, der erstellt wird. Nur eine von ihnen muss angegeben werden:

federated Optional

Ein FederatedCredentialInit Objekt, das Anforderungen enthält, um ein föderiertes Identitätsanbieter-Credential zu erstellen.

password Optional

Ein PasswordCredentialInit Objekt, das Anforderungen enthält, um ein Passwort-Credential zu erstellen.

publicKey Optional

Ein PublicKeyCredentialCreationOptions Objekt, das Anforderungen für das Erstellen eines öffentlichen Schlüssel-Credentials enthält. Verursacht, dass der create() Aufruf den User-Agent auffordert, neue Credentials über ein Authentifizierungsgerät zu erstellen – entweder um ein neues Konto zu registrieren oder um ein neues asymmetrisches Schlüsselpaar mit einem bestehenden Konto zu verknüpfen.

Hinweis: Die Verwendung von create() mit dem publicKey Parameter kann durch eine publickey-credentials-create Berechtigungsrichtlinie, die auf Ihrem Server festgelegt ist, blockiert werden.

Ein Promise, das mit einem der folgenden auflöst:

• Ein FederatedCredential, wenn der Credential-Typ federated war.
• Ein PasswordCredential, wenn der Credential-Typ password war.
• Ein PublicKeyCredential, wenn der Credential-Typ publicKey war.

Wenn kein Credential-Objekt erstellt werden kann, löst das Versprechen mit null auf.

TypeError

Im Falle eines PasswordCredential Erstellungsgesuchs wurden id, origin oder password nicht bereitgestellt (leer).

NotAllowedError DOMException

Mögliche Ursachen sind:

• Die Nutzung wurde durch eine publickey-credentials-create Berechtigungsrichtlinie blockiert.
• Die Funktion wird über Herkunftsgrenzen hinweg aufgerufen, aber das allow Attribut des <iframe> setzt keine geeignete publickey-credentials-create Richtlinie.
• Die Funktion wird über Herkunftsgrenzen hinweg aufgerufen und das <iframe> verfügt nicht über eine flüchtige Aktivierung.
• Es wird versucht, ein erkennbares Credential (residentKey ist in der create() Aufrufsoption auf required gesetzt), zu erstellen, aber der Benutzer hat keinen Sicherheitsschlüssel, der erkennbare Credentials unterstützt, und bricht den Vorgang ab.

AbortError DOMException

Der Vorgang wurde abgebrochen.

Dieses Beispiel erstellt ein Passwort-Credential aus einem PasswordCredentialInit Objekt.

const credInit = {
  id: "1234",
  name: "Serpentina",
  origin: "https://example.org",
  password: "the last visible dog",
};

const makeCredential = document.querySelector("#make-credential");

makeCredential.addEventListener("click", async () => {
  const cred = await navigator.credentials.create({
    password: credInit,
  });
  console.log(cred.name);
  // Serpentina
  console.log(cred.password);
  // the last visible dog
});

Dieses Beispiel erstellt ein föderiertes Credential aus einem FederatedCredentialInit Objekt.

const credInit = {
  id: "1234",
  name: "Serpentina",
  origin: "https://example.org",
  protocol: "openidconnect",
  provider: "https://provider.example.org",
};

const makeCredential = document.querySelector("#make-credential");

makeCredential.addEventListener("click", async () => {
  const cred = await navigator.credentials.create({
    federated: credInit,
  });
  console.log(cred.name);
  console.log(cred.provider);
});

Dieses Beispiel erstellt ein öffentliches Schlüssel-Credential aus einem PublicKeyCredentialCreationOptions Objekt.

const publicKey = {
  challenge: challengeFromServer,
  rp: { id: "acme.com", name: "ACME Corporation" },
  user: {
    id: new Uint8Array([79, 252, 83, 72, 214, 7, 89, 26]),
    name: "jamiedoe",
    displayName: "Jamie Doe",
  },
  pubKeyCredParams: [{ type: "public-key", alg: -7 }],
};

const publicKeyCredential = await navigator.credentials.create({ publicKey });

Der create() Aufruf liefert, falls erfolgreich, ein Versprechen, das mit einem PublicKeyCredential Objektinstanz auflöst, das ein öffentliches Schlüssel-Credential darstellt, das später verwendet werden kann, um einen Benutzer über einen WebAuthn get() Aufruf zu authentifizieren. Eigenschaften von PublicKeyCredential.response enthalten ein AuthenticatorAttestationResponse Objekt, das Zugriff auf mehrere nützliche Informationen bietet, einschließlich Authentifikator-Daten, öffentlichen Schlüssel, Transportmechanismen und mehr.

navigator.credentials.create({ publicKey }).then((publicKeyCredential) => {
  const response = publicKeyCredential.response;

  // Access attestationObject ArrayBuffer
  const attestationObj = response.attestationObject;

  // Access client JSON
  const clientJSON = response.clientDataJSON;

  // Return authenticator data ArrayBuffer
  const authenticatorData = response.getAuthenticatorData();

  // Return public key ArrayBuffer
  const pk = response.getPublicKey();

  // Return public key algorithm identifier
  const pkAlgo = response.getPublicKeyAlgorithm();

  // Return permissible transports array
  const transports = response.getTransports();
});

Einige dieser Daten müssen auf dem Server für zukünftige Authentifizierungsvorgänge gegen dieses Credential gespeichert werden - zum Beispiel der öffentliche Schlüssel, der verwendete Algorithmus und die zulässigen Transporte.