1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
---
title: PublicKeyCredential
slug: Web/API/PublicKeyCredential
tags:
- API
- Authentication
- Interface
- PublicKeyCredential
- Reference
- Web Authentication API
- WebAuthn
- インターフェイス
translation_of: Web/API/PublicKeyCredential
---
<div>{{APIRef("Web Authentication API")}}{{securecontext_header}}</div>
<p><code><strong>PublicKeyCredential</strong></code> インターフェイスは、パスワードの代わりにフィッシングやデータ消去に耐性のある非対称の鍵ペアを使用してサービスにログインするための資格情報である、公開鍵と秘密鍵のペアについての情報を提供します。これは {{domxref("Credential")}} を継承しており、 <a href="/ja/docs/Web/API/Web_Authentication_API">Web Authentication API</a> が <a href="/ja/docs/Web/API/Credential_Management_API">Credential Management API</a> へ拡張された際に作成されました。 {{domxref("Credential")}} を継承している他のインターフェイスとしては、 {{domxref("PasswordCredential")}} や {{domxref("FederatedCredential")}} があります。</p>
<div class="note">
<p><strong>メモ:</strong> このインターフェイスは最上位のコンテキストに限定されています。 {{HTMLElement("iframe")}} 要素の中で使用しても、何も効果がありません。</p>
</div>
<h2 id="Properties" name="Properties">プロパティ</h2>
<dl>
<dt><code>PublicKeyCredential.type</code> {{ReadOnlyInline()}}{{securecontext_inline}}</dt>
<dd>{{domxref("Credential")}} から継承しています。 <code>PublicKeyCredential</code> の場合は、常に <code>public-key</code> に設定されています。</dd>
<dt>{{domxref("PublicKeyCredential.id")}} {{ReadOnlyInline()}}{{securecontext_inline}}</dt>
<dd>{{domxref("Credential")}} から継承しており、 {{domxref("PublicKeyCredential.rawId")}} の <a href="/ja/docs/Web/API/WindowBase64/Base64_encoding_and_decoding">base64url 符号化</a>になるようオーバーライドしています。</dd>
<dt>{{domxref("PublicKeyCredential.rawId")}} {{ReadOnlyInline()}}{{securecontext_inline}}</dt>
<dd>{{domxref("ArrayBuffer")}} 型で、この <code>PublicKeyCredential</code> のグローバルに固有な識別子を保持します。この識別子は今後の {{domxref("CredentialsContainer.get")}} の呼び出しにおいて、資格情報を検索するのに使用することができます。</dd>
<dt>{{domxref("PublicKeyCredential.response")}} {{ReadOnlyInline()}} {{securecontext_inline}}</dt>
<dd>{{domxref("AuthenticatorResponse")}} オブジェクトのインスタンスです。これは <code>PublicKeyCredential</code> が {{domxref("CredentialsContainer.create()","navigator.credentials.create()")}} の呼び出しの結果だった場合であった場合は {{domxref("AuthenticatorAttestationResponse")}} 型に、 <code>PublicKeyCredential</code> が {{domxref("CredentialsContainer.get()","navigator.credentials.get()")}} の呼び出しの結果であった場合は {{domxref("AuthenticatorAssertionResponse")}} 型になります。</dd>
</dl>
<h2 id="Methods" name="Methods">メソッド</h2>
<dl>
<dt>{{domxref("PublicKeyCredential.getClientExtensionResults()")}}{{securecontext_inline}}</dt>
<dd>何らかの拡張機能がリクエストされた場合、このメソッドはその拡張機能が処理した結果を返します。</dd>
<dt>{{domxref("PublicKeyCredential.isUserVerifyingPlatformAuthenticatorAvailable()")}}{{securecontext_inline}}</dt>
<dd>静的メソッドで、認証機器が所属するプラットフォームがユーザーを<em>検証</em>する能力を持っているならば <code>true</code> で解決する {{jsxref("Promise")}} を返します。現在の実装状況では、このメソッドは <a href="https://docs.microsoft.com/en-us/microsoft-edge/dev-guide/windows-integration/web-authentication">Windows Hello</a> がシステムで利用可能な場合のみ <code>true</code> で解決します。</dd>
</dl>
<h2 id="Examples" name="Examples">例</h2>
<h3 id="Creating_a_new_instance_of_PublicKeyCredential" name="Creating_a_new_instance_of_PublicKeyCredential">PublicKeyCredential の新しいインスタンスを生成</h3>
<p>ここでは、 {{domxref("CredentialsContainer.create()","navigator.credentials.create()")}} を用いて新しい資格情報を生成します。</p>
<pre class="brush: js">var publicKey = {
challenge: /* from the server */,
rp: {
name: "Example CORP",
id : "login.example.com"
},
user: {
id: new Uint8Array(16),
name: "jdoe@example.com",
displayName: "John Doe"
},
pubKeyCredParams: [
{
type: "public-key",
alg: -7
}
]
};
navigator.credentials.create({ publicKey })
.then(function (newCredentialInfo) {
var response = newCredentialInfo.response;
var clientExtensionsResults = newCredentialInfo.getClientExtensionResults();
}).catch(function (err) {
console.error(err);
});</pre>
<h3 id="Getting_an_existing_instance_of_PublicKeyCredential" name="Getting_an_existing_instance_of_PublicKeyCredential">PublicKeyCredential の既存のインスタンスを取得</h3>
<p>ここでは、 {{domxref("CredentialsContainer.get()","navigator.credentials.get()")}} を用いて認証機器から既存の資格情報を読み取ります。</p>
<pre class="brush: js">var options = {
challenge: new Uint8Array([/* bytes sent from the server */])
};
navigator.credentials.get({ "publicKey": options })
.then(function (credentialInfoAssertion) {
// send assertion response back to the server
// to proceed with the control of the credential
}).catch(function (err) {
console.error(err);
});
</pre>
<h2 id="Specifications" name="Specifications">仕様書</h2>
<table class="standard-table">
<thead>
<tr>
<th scope="col">仕様書</th>
<th scope="col">状態</th>
<th scope="col">備考</th>
</tr>
</thead>
<tbody>
<tr>
<td>{{SpecName('WebAuthn','#iface-pkcredential','PublicKeyCredential interface')}}</td>
<td>{{Spec2('WebAuthn')}}</td>
<td>初回定義</td>
</tr>
</tbody>
</table>
<h2 id="Browser_compatibility" name="Browser_compatibility">ブラウザーの互換性</h2>
<div class="hidden">このページの互換性一覧表は構造化データから生成されています。データに協力していただけるのであれば、 <a class="external" href="https://github.com/mdn/browser-compat-data">https://github.com/mdn/browser-compat-data</a> をチェックアウトしてプルリクエストを送信してください。</div>
<p>{{Compat("api.PublicKeyCredential")}}</p>
<h2 id="See_also" name="See_also">関連情報</h2>
<ul>
<li>親インターフェイスの {{domxref("Credential")}}</li>
</ul>
|
