Internet Engineering Task Force (IETF) K. Watsen
Request for Comments: 9642 Watsen Networks
Category: Standards Track October 2024
ISSN: 2070-1721
This document presents a YANG module called "ietf-keystore" that enables centralized configuration of both symmetric and asymmetric keys. The secret value for both key types may be encrypted or hidden. Asymmetric keys may be associated with certificates. Notifications are sent when certificates are about to expire.
このドキュメントでは、対称キーと非対称キーの両方の集中構成を可能にする「IETFキーストア」と呼ばれるYangモジュールを提示します。両方のキータイプの秘密の値は、暗号化または非表示にすることができます。非対称キーは証明書に関連付けられている場合があります。証明書が期限切れになっているときに通知が送信されます。
This is an Internet Standards Track document.
これは、インターネット標準トラックドキュメントです。
This document is a product of the Internet Engineering Task Force (IETF). It represents the consensus of the IETF community. It has received public review and has been approved for publication by the Internet Engineering Steering Group (IESG). Further information on Internet Standards is available in Section 2 of RFC 7841.
このドキュメントは、インターネットエンジニアリングタスクフォース（IETF）の製品です。IETFコミュニティのコンセンサスを表しています。公開レビューを受けており、インターネットエンジニアリングステアリンググループ（IESG）からの出版が承認されています。インターネット標準の詳細については、RFC 7841のセクション2で入手できます。
Information about the current status of this document, any errata, and how to provide feedback on it may be obtained at https://www.rfc-editor.org/info/rfc9642.
このドキュメントの現在のステータス、任意のERRATA、およびそのフィードバックを提供する方法に関する情報は、https://www.rfc-editor.org/info/rfc9642で取得できます。
Copyright (c) 2024 IETF Trust and the persons identified as the document authors. All rights reserved.
著作権（c）2024 IETF Trustおよび文書著者として特定された人。無断転載を禁じます。
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Revised BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Revised BSD License.
このドキュメントは、BCP 78およびIETFドキュメント（https://trustee.ietf.org/license-info）に関連するIETF Trustの法的規定の対象となります。この文書に関するあなたの権利と制限を説明するので、これらの文書を注意深く確認してください。このドキュメントから抽出されたコードコンポーネントには、セクション4.Eで説明されている法的規定のセクション4.Eで説明されており、修正されたBSDライセンスで説明されている保証なしで提供されるように、改訂されたBSDライセンステキストを含める必要があります。
1. Introduction
1.1. Relation to Other RFCs
1.2. Specification Language
1.3. Terminology
1.4. Adherence to the NMDA
1.5. Conventions
2. The "ietf-keystore" Module
2.1. Data Model Overview
2.2. Example Usage
2.3. YANG Module
3. Support for Built-In Keys
4. Encrypting Keys in Configuration
5. Security Considerations
5.1. Security of Data at Rest and in Motion
5.2. Unconstrained Private Key Usage
5.3. Security Considerations for the "ietf-keystore" YANG Module
6. IANA Considerations
6.1. The IETF XML Registry
6.2. The YANG Module Names Registry
7. References
7.1. Normative References
7.2. Informative References
Acknowledgements
Author's Address
This document presents a YANG 1.1 [RFC7950] module called "ietf-keystore" that enables centralized configuration of both symmetric and asymmetric keys. The secret value for both key types may be encrypted or hidden (see [RFC9640]). Asymmetric keys may be associated with certificates. Notifications are sent when certificates are about to expire.
このドキュメントでは、対称キーと非対称キーの両方の集中構成を可能にする「IETFキーストア」と呼ばれるYang 1.1 [RFC7950]モジュールを紹介します。両方のキータイプの秘密の値は、暗号化または非表示にすることができます（[RFC9640]を参照）。非対称キーは証明書に関連付けられている場合があります。証明書が期限切れになっているときに通知が送信されます。
The "ietf-keystore" module defines many "grouping" statements intended for use by other modules that may import it. For instance, there are groupings that define enabling a key to be configured either inline (within the defining data model) or as a reference to a key in the central keystore.
「IETF-Keystore」モジュールは、インポートする可能性のある他のモジュールが使用することを目的とした多くの「グループ化」ステートメントを定義しています。たとえば、[データモデルの定義モデル内）または中央キーストアのキーへの参照として、キーをインラインのいずれかのいずれかを構成できるようにすることを定義するグループがあります。
Special consideration has been given for servers that have cryptographic hardware, such as a trusted platform module (TPM). These servers are unique in that the cryptographic hardware hides the secret key values. Additionally, such hardware is commonly initialized when manufactured to protect a "built-in" asymmetric key for which its public half is conveyed in an identity certificate (e.g., an Initial Device Identifier (IDevID) [Std-802.1AR-2018] certificate). See how built-in keys are supported in Section 3.
信頼できるプラットフォームモジュール（TPM）など、暗号化ハードウェアを備えたサーバーに特別な考慮事項が与えられています。これらのサーバーは、暗号化ハードウェアがシークレットキー値を隠すという点でユニークです。さらに、そのようなハードウェアは、一般に、「組み込みの」非対称キーを保護するために製造されたときに初期化されます。そのパブリックハーフがID証明書（例：初期デバイス識別子（IDEVID）[STD-802.1AR-2018]証明書）で伝達されます。。セクション3で組み込みのキーがどのようにサポートされているかを参照してください。
This document is intended to reflect existing practices that many server implementations support at the time of writing. To simplify implementation, advanced key formats may be selectively implemented.
このドキュメントは、多くのサーバーの実装が執筆時点でサポートされている既存のプラクティスを反映することを目的としています。実装を簡素化するために、高度なキーフォーマットを選択的に実装できます。
Implementations may utilize operating-system level keystore utilities (e.g., "Keychain Access" on MacOS) and/or cryptographic hardware (e.g., TPMs).
実装では、オペレーティングシステムレベルのキーストアユーティリティ（たとえば、MacOSの「キーチェーンアクセス」）および/または暗号化ハードウェア（TPMなど）を利用する場合があります。
This document presents a YANG module [RFC7950] that is part of a collection of RFCs that work together to ultimately support the configuration of both the clients and servers of the Network Configuration Protocol (NETCONF) [RFC6241] and RESTCONF [RFC8040].
このドキュメントでは、ネットワーク構成プロトコル（NetConf）[RFC6241]とreptConf [RFC8040]のクライアントとサーバーの両方の構成を最終的にサポートするために連携するRFCのコレクションの一部であるYangモジュール[RFC7950]を示します。
The dependency relationship between the primary YANG groupings defined in the various RFCs is presented in the diagram below. In some cases, a document may define secondary groupings that introduce dependencies not illustrated in the diagram. The labels in the diagram are shorthand names for the defining RFCs. The citation references for the shorthand names are provided below the diagram.
さまざまなRFCで定義されている主要なヤングループ間の依存関係については、以下の図に示されています。場合によっては、ドキュメントは、図に示されていない依存関係を導入する二次グループを定義する場合があります。図のラベルは、定義するRFCの略語名です。速記の名前の引用参照は、図の下に記載されています。
Please note that the arrows in the diagram point from referencer to referenced. For example, the "crypto-types" RFC does not have any dependencies, whilst the "keystore" RFC depends on the "crypto-types" RFC.
参照者から参照されるまでの図の矢印に注意してください。たとえば、「暗号タイプ」RFCには依存関係がありませんが、「キーストア」RFCは「暗号タイプ」RFCに依存します。
crypto-types
^ ^
/ \
/ \
truststore keystore
^ ^ ^ ^
| +---------+ | |
| | | |
| +------------+ |
tcp-client-server | / | |
^ ^ ssh-client-server | |
| | ^ tls-client-server
| | | ^ ^ http-client-server
| | | | | ^
| | | +-----+ +---------+ |
| | | | | |
| +-----------|--------|--------------+ | |
| | | | | |
+-----------+ | | | | |
| | | | | |
| | | | | |
netconf-client-server restconf-client-server
+========================+==========================+
| Label in Diagram | Originating RFC |
+========================+==========================+
| crypto-types | [RFC9640] |
+------------------------+--------------------------+
| truststore | [RFC9641] |
+------------------------+--------------------------+
| keystore | RFC 9642 |
+------------------------+--------------------------+
| tcp-client-server | [RFC9643] |
+------------------------+--------------------------+
| ssh-client-server | [RFC9644] |
+------------------------+--------------------------+
| tls-client-server | [RFC9645] |
+------------------------+--------------------------+
| http-client-server | [HTTP-CLIENT-SERVER] |
+------------------------+--------------------------+
| netconf-client-server | [NETCONF-CLIENT-SERVER] |
+------------------------+--------------------------+
| restconf-client-server | [RESTCONF-CLIENT-SERVER] |
+------------------------+--------------------------+
Table 1: Labels in Diagram to RFC Mapping
表1：RFCマッピングへの図のラベル
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.
「必須」、「必要」、「必須」、「shall」、「shall」、「suff」、 "not"、 "becommended"、 "becommented"、 "may"、 "optional「このドキュメントでは、BCP 14 [RFC2119] [RFC8174]で説明されているように解釈されます。
The terms "client" and "server" are defined in [RFC6241] and are not redefined here.
「クライアント」と「サーバー」という用語は[RFC6241]で定義されており、ここでは再定義されていません。
The term "keystore" is defined in this document as a mechanism that intends to safeguard secrets.
「キーストア」という用語は、このドキュメントで秘密を保護することを目的としたメカニズムとして定義されています。
The nomenclatures "<running>" and "<operational>" are defined in [RFC8342].
命名法「<runing>」と「<Operational>」は[RFC8342]で定義されています。
The sentence fragments "augmented" and "augmented in" are used herein as the past tense verbified form of the "augment" statement defined in Section 7.17 of [RFC7950].
[RFC7950]のセクション7.17で定義された「増強」ステートメントの過去形の冗長な形式として、本明細書で「補強された」および「補強」文の断片が使用されます。
The term "key" may be used to mean one of three things in this document: 1) the YANG-defined "asymmetric-key" or "symmetric-key" node defined in this document, 2) the raw key data possessed by the aforementioned key nodes, or 3) the "key" of a YANG "list" statement. This document qualifies types '2' and '3' using "raw key value" and "YANG list key" where needed. In all other cases, an unqualified "key" refers to a YANG-defined "asymmetric-key" or "symmetric-key" node.
「キー」という用語は、このドキュメントの3つのことのいずれかを意味するために使用できます。1）このドキュメントで定義されているYang定義の「非対称キー」または「対称キー」ノード、2）前述のキーノード、または3）Yang "リスト"ステートメントの「キー」。このドキュメントは、必要に応じて「生のキー値」と「ヤンリストキー」を使用して、「2」と「3」が適格です。他のすべてのケースでは、資格のない「キー」とは、ヤン定義の「非対称キー」または「対称キー」ノードを指します。
This document is compliant with Network Management Datastore Architecture (NMDA) [RFC8342]. For instance, keys and associated certificates installed during manufacturing (e.g., for an IDevID certificate) are expected to appear in <operational> (see Section 3).
このドキュメントは、ネットワーク管理データストアアーキテクチャ（NMDA）[RFC8342]に準拠しています。たとえば、製造中にインストールされたキーと関連する証明書（例：IDEVID証明書の場合）は、<Operational>に表示されると予想されます（セクション3を参照）。
Various examples in this document use "BASE64VALUE=" as a placeholder value for binary data that has been base64 encoded (per Section 9.8 of [RFC7950]). This placeholder value is used because real base64-encoded structures are often many lines long and hence distracting to the example being presented.
このドキュメントのさまざまな例では、base64エンコードされたバイナリデータのプレースホルダー値として「base64Value =」を使用します（[RFC7950]のセクション9.8ごと）。このプレースホルダーの価値は、実際のBase64でエンコードされた構造が多くの長さの長さであるため、提示されている例に気を取るため、このプレースホルダーの価値が使用されます。
Various examples in this document use the XML [W3C.REC-xml-20081126] encoding. Other encodings, such as JSON [RFC8259], could alternatively be used.
このドキュメントのさまざまな例は、XML [W3C.REC-XML-20081126]エンコードを使用しています。JSON [RFC8259]などのその他のエンコーディングを代わりに使用できます。
Various examples in this document contain long lines that may be folded, as described in [RFC8792].
このドキュメントのさまざまな例には、[RFC8792]で説明されているように、折り畳まれる可能性のある長い行が含まれています。
This document uses the adjective "central" to the word "keystore" to refer to the top-level instance of the "keystore-grouping", when the "central-keystore-supported" feature is enabled. Please be aware that consuming YANG modules MAY instantiate the "keystore-grouping" in other locations. All such other instances are not the "central" instance.
このドキュメントでは、「キーストア」という単語の「中央」を使用して、「キーストアグループ」のトップレベルインスタンスを指します。ヤンモジュールを消費すると、他の場所の「キーストアグループ」がインスタンス化される可能性があることに注意してください。そのような他のすべてのインスタンスは、「中央」のインスタンスではありません。
This section defines a YANG 1.1 [RFC7950] module called "ietf-keystore". A high-level overview of the module is provided in Section 2.1. Examples illustrating the module's use are provided in Section 2.2. The YANG module itself is defined in Section 2.3.
このセクションでは、「IETF-KeyStore」と呼ばれるYang 1.1 [RFC7950]モジュールを定義します。モジュールの高レベルの概要は、セクション2.1に記載されています。モジュールの使用を示す例は、セクション2.2に記載されています。Yangモジュール自体は、セクション2.3で定義されています。
This section provides an overview of the "ietf-keystore" module in terms of its features, typedefs, groupings, and protocol-accessible nodes.
このセクションでは、その機能、typedef、グループ化、およびプロトコルアクセス可能なノードの観点から、「IETF-Keystore」モジュールの概要を説明します。
The following diagram lists all the "feature" statements defined in the "ietf-keystore" module:
次の図には、「IETFキーストア」モジュールで定義されているすべての「機能」ステートメントを示します。
Features:
+-- central-keystore-supported
+-- inline-definitions-supported
+-- asymmetric-keys
+-- symmetric-keys
The diagram above uses syntax that is similar to but not defined in [RFC8340].
上記の図は、[RFC8340]で定義されていないものに似ていない構文を使用します。
The following diagram lists the "typedef" statements defined in the "ietf-keystore" module:
次の図には、「IETF-Keystore」モジュールで定義されている「typedef」ステートメントを示します。
Typedefs:
leafref
+-- central-symmetric-key-ref
+-- central-asymmetric-key-ref
The diagram above uses syntax that is similar to but not defined in [RFC8340].
上記の図は、[RFC8340]で定義されていないものに似ていない構文を使用します。
Comments:
コメント：
* All the typedefs defined in the "ietf-keystore" module extend the base "leafref" type defined in [RFC7950].
* [RFC7950]で定義されている「IETF-Keystore」モジュールで定義されているすべてのtypedefsは、[RFC7950]で定義されたベース「Leafref」タイプを拡張します。
* The leafrefs refer to symmetric and asymmetric keys in the central keystore when this module is implemented.
* LeafRefsは、このモジュールが実装されているときに、中央キーストアの対称キーと非対称キーを指します。
* These typedefs are provided as an aid to consuming modules that import the "ietf-keystore" module.
* これらのtypedefsは、「ietf-keystore」モジュールをインポートするモジュールを消費するための援助として提供されます。
The "ietf-keystore" module defines the following "grouping" statements:
「ietf-keystore」モジュールは、次の「グループ化」ステートメントを定義します。
* encrypted-by-grouping
* 暗号化されたグループ
* central-asymmetric-key-certificate-ref-grouping
* 中央アサイメトリックキー教者と再グループ化
* inline-or-keystore-symmetric-key-grouping
* インラインオアキーストア - サイドメトリックキーグループ
* inline-or-keystore-asymmetric-key-grouping
* インラインオアキーストア - アシムメトリックキーグループ
* inline-or-keystore-asymmetric-key-with-certs-grouping
* インラインオアキーストア - アシムメトリックキーウィットcerts-frouping
* inline-or-keystore-end-entity-cert-with-key-grouping
* Inline-or-Keystore-end-entity-cert-with-key-grouping
* keystore-grouping
* キーストアグループ
Each of these groupings are presented in the following subsections.
これらの各グループは、次のサブセクションに記載されています。
The following tree diagram [RFC8340] illustrates the "encrypted-by-grouping" grouping:
次のツリー図[RFC8340]は、「暗号化されたグループごとの」グループ化を示しています。
grouping encrypted-by-grouping:
+-- (encrypted-by)
+--:(central-symmetric-key-ref)
| {central-keystore-supported,symmetric-keys}?
| +-- symmetric-key-ref? ks:central-symmetric-key-ref
+--:(central-asymmetric-key-ref)
{central-keystore-supported,asymmetric-keys}?
+-- asymmetric-key-ref? ks:central-asymmetric-key-ref
Comments:
コメント：
* This grouping defines a "choice" statement with options to reference either a symmetric or an asymmetric key configured in the keystore.
* このグループ化は、キーストアで構成された対称キーまたは非対称キーのいずれかを参照するオプションを備えた「選択」ステートメントを定義します。
* This grouping is usable only when the keystore module is implemented. Servers defining custom keystore locations MUST augment in alternate "encrypted-by" references to the alternate locations.
* このグループ化は、キーストアモジュールが実装されている場合にのみ使用できます。カスタムキーストアの場所を定義するサーバーは、代替場所への代替「暗号化された」参照で拡張する必要があります。
The following tree diagram [RFC8340] illustrates the "central-asymmetric-key-certificate-ref-grouping" grouping:
次のツリー図[RFC8340]は、「中央アサイムメトリックキー教能性 - リフグループ」グループ化を示しています。
grouping central-asymmetric-key-certificate-ref-grouping:
+-- asymmetric-key? ks:central-asymmetric-key-ref
| {central-keystore-supported,asymmetric-keys}?
+-- certificate? leafref
Comments:
コメント：
* This grouping defines a reference to a certificate in two parts: the first being the name of the asymmetric key the certificate is associated with, and the second being the name of the certificate itself.
* このグループ化は、2つの部分の証明書への参照を定義します。1つ目は、証明書が関連付けられている非対称キーの名前であり、2つ目は証明書自体の名前です。
* This grouping is usable only when the keystore module is implemented. Servers defining custom keystore locations can define an alternate grouping for references to the alternate locations.
* このグループ化は、キーストアモジュールが実装されている場合にのみ使用できます。カスタムキーストアの場所を定義するサーバーは、代替場所への参照の代替グループ化を定義できます。
The following tree diagram [RFC8340] illustrates the "inline-or-keystore-symmetric-key-grouping" grouping:
次のツリー図[rfc8340]は、「インラインまたはキーストアの王と非対称グループ」グループのグループ化を示しています。
grouping inline-or-keystore-symmetric-key-grouping:
+-- (inline-or-keystore)
+--:(inline) {inline-definitions-supported}?
| +-- inline-definition
| +---u ct:symmetric-key-grouping
+--:(central-keystore)
{central-keystore-supported,symmetric-keys}?
+-- central-keystore-reference?
ks:central-symmetric-key-ref
Comments:
コメント：
* The "inline-or-keystore-symmetric-key-grouping" grouping is provided solely as convenience to consuming modules that wish to offer an option for a symmetric key that is defined either inline or as a reference to a symmetric key in the keystore.
* 「インラインオアキーストア - サインメトリックキーグループ」グループは、インラインまたはキーストアの対称キーへの参照として定義される対称キーのオプションを提供したいモジュールを消費するための利便性としてのみ提供されます。
* A "choice" statement is used to expose the various options. Each option is enabled by a "feature" statement. Additional "case" statements MAY be augmented in if, e.g., there is a need to reference a symmetric key in an alternate location.
* 「選択」ステートメントは、さまざまなオプションを公開するために使用されます。各オプションは、「機能」ステートメントによって有効になります。追加の「ケース」ステートメントは、たとえば、代替場所の対称キーを参照する必要がある場合に補強される場合があります。
* For the "inline-definition" option, the definition uses the "symmetric-key-grouping" grouping discussed in Section 2.1.4.3 of [RFC9640].
* 「インライン解像度」オプションの場合、定義は[RFC9640]のセクション2.1.4.3で説明した「対称キーグループ」グループ化を使用します。
* For the "central-keystore" option, the "central-keystore-reference" is an instance of the "symmetric-key-ref" discussed in Section 2.1.2.
* 「Central-Keystore」オプションの場合、「Central-Keystore-reference」は、セクション2.1.2で説明した「対称キーレフ」のインスタンスです。
The following tree diagram [RFC8340] illustrates the "inline-or-keystore-asymmetric-key-grouping" grouping:
次のツリー図[RFC8340]は、「インラインまたはキーストア - アシムメトリックキーグループ」グループ化を示しています。
grouping inline-or-keystore-asymmetric-key-grouping:
+-- (inline-or-keystore)
+--:(inline) {inline-definitions-supported}?
| +-- inline-definition
| +---u ct:asymmetric-key-pair-grouping
+--:(central-keystore)
{central-keystore-supported,asymmetric-keys}?
+-- central-keystore-reference?
ks:central-asymmetric-key-ref
Comments:
コメント：
* The "inline-or-keystore-asymmetric-key-grouping" grouping is provided solely as convenience to consuming modules that wish to offer an option for an asymmetric key that is defined either inline or as a reference to an asymmetric key in the keystore.
* 「インラインオアキーストア - アジャンメトリックキーグループ」グループは、インラインまたはキーストアの非対称キーへの参照として定義される非対称キーのオプションを提供したいモジュールを消費するための利便性としてのみ提供されます。
* A "choice" statement is used to expose the various options. Each option is enabled by a "feature" statement. Additional "case" statements MAY be augmented in if, e.g., there is a need to reference an asymmetric key in an alternate location.
* 「選択」ステートメントは、さまざまなオプションを公開するために使用されます。各オプションは、「機能」ステートメントによって有効になります。追加の「ケース」ステートメントは、たとえば、代替場所の非対称キーを参照する必要がある場合に増強される場合があります。
* For the "inline-definition" option, the definition uses the "asymmetric-key-pair-grouping" grouping discussed in Section 2.1.4.6 of [RFC9640].
* 「インライン定義」オプションの場合、定義は[RFC9640]のセクション2.1.4.6で説明した「非対称キーペアグループ」グループ化を使用します。
* For the "central-keystore" option, the "central-keystore-reference" is an instance of the "asymmetric-key-ref" typedef discussed in Section 2.1.2.
* 「Central-Keystore」オプションの場合、「Central-Keystore-reference」は、セクション2.1.2で説明した「非対称キーレフ」typedefのインスタンスです。
The following tree diagram [RFC8340] illustrates the "inline-or-keystore-asymmetric-key-with-certs-grouping" grouping:
次のツリー図[RFC8340]は、「インラインまたはキーストア - アシムメトリックキーウィットケルトグループ」グループ化を示しています。
grouping inline-or-keystore-asymmetric-key-with-certs-grouping:
+-- (inline-or-keystore)
+--:(inline) {inline-definitions-supported}?
| +-- inline-definition
| +---u ct:asymmetric-key-pair-with-certs-grouping
+--:(central-keystore)
{central-keystore-supported,asymmetric-keys}?
+-- central-keystore-reference?
ks:central-asymmetric-key-ref
Comments:
コメント：
* The "inline-or-keystore-asymmetric-key-with-certs-grouping" grouping is provided solely as convenience to consuming modules that wish to offer an option for an asymmetric key that is defined either inline or as a reference to an asymmetric key in the keystore.
* 「インラインオアキーストア - アジメトリキーウィットケルトグループ」グループ化は、インラインまたは非対称キーへの参照として定義される非対称キーのオプションを提供したいモジュールを消費するための利便性としてのみ提供されます。キーストアで。
* A "choice" statement is used to expose the various options. Each option is enabled by a "feature" statement. Additional "case" statements MAY be augmented in if, e.g., there is a need to reference an asymmetric key in an alternate location.
* 「選択」ステートメントは、さまざまなオプションを公開するために使用されます。各オプションは、「機能」ステートメントによって有効になります。追加の「ケース」ステートメントは、たとえば、代替場所の非対称キーを参照する必要がある場合に増強される場合があります。
* For the "inline-definition" option, the definition uses the "asymmetric-key-pair-with-certs-grouping" grouping discussed in Section 2.1.4.12 of [RFC9640].
* 「インライン定義」オプションの場合、定義は[RFC9640]のセクション2.1.4.12で説明した「非対称キーペアと洞窟グループ」グループ化を使用します。
* For the "central-keystore" option, the "central-keystore-reference" is an instance of the "asymmetric-key-ref" typedef discussed in Section 2.1.2.
* 「Central-Keystore」オプションの場合、「Central-Keystore-reference」は、セクション2.1.2で説明した「非対称キーレフ」typedefのインスタンスです。
The following tree diagram [RFC8340] illustrates the "inline-or-keystore-end-entity-cert-with-key-grouping" grouping:
次のツリー図[RFC8340]は、「インラインまたはキーストアエンドエンティティ - キーグループ」グループ化を示しています。
grouping inline-or-keystore-end-entity-cert-with-key-grouping:
+-- (inline-or-keystore)
+--:(inline) {inline-definitions-supported}?
| +-- inline-definition
| +---u ct:asymmetric-key-pair-with-cert-grouping
+--:(central-keystore)
{central-keystore-supported,asymmetric-keys}?
+-- central-keystore-reference
+---u central-asymmetric-key-certificate-ref-grouping
Comments:
コメント：
* The "inline-or-keystore-end-entity-cert-with-key-grouping" grouping is provided solely as convenience to consuming modules that wish to offer an option for a symmetric key that is defined either inline or as a reference to a symmetric key in the keystore.
* 「インラインオアキーストアエンド - エンティティ - キーグループ」グループ化は、インラインまたはインラインまたはの参照として定義される対称キーのオプションを提供したいモジュールを消費するための利便性としてのみ提供されます。キーストアの対称キー。
* A "choice" statement is used to expose the various options. Each option is enabled by a "feature" statement. Additional "case" statements MAY be augmented in if, e.g., there is a need to reference a symmetric key in an alternate location.
* 「選択」ステートメントは、さまざまなオプションを公開するために使用されます。各オプションは、「機能」ステートメントによって有効になります。追加の「ケース」ステートメントは、たとえば、代替場所の対称キーを参照する必要がある場合に補強される場合があります。
* For the "inline-definition" option, the definition uses the "asymmetric-key-pair-with-certs-grouping" grouping discussed in Section 2.1.4.12 of [RFC9640].
* 「インライン定義」オプションの場合、定義は[RFC9640]のセクション2.1.4.12で説明した「非対称キーペアと洞窟グループ」グループ化を使用します。
* For the "central-keystore" option, the "central-keystore-reference" uses the "central-asymmetric-key-certificate-ref-grouping" grouping discussed in Section 2.1.3.2.
* 「セントラルキーストア」オプションの場合、「セントラルキーストアの参照」は、セクション2.1.3.2で説明した「セントラルアサイムメトリックキー - 教師 - レフグループ」グループを使用します。
The following tree diagram [RFC8340] illustrates the "keystore-grouping" grouping:
次のツリー図[RFC8340]は、「キーストアグループ」グループ化を示しています。
grouping keystore-grouping:
+-- asymmetric-keys {asymmetric-keys}?
| +-- asymmetric-key* [name]
| +-- name string
| +---u ct:asymmetric-key-pair-with-certs-grouping
+-- symmetric-keys {symmetric-keys}?
+-- symmetric-key* [name]
+-- name string
+---u ct:symmetric-key-grouping
Comments:
コメント：
* The "keystore-grouping" grouping defines a keystore instance as being composed of symmetric and asymmetric keys. The structure for the symmetric and asymmetric keys is essentially the same: a "list" inside a "container".
* 「キーストアグループ」グループ化は、キーストアインスタンスを対称的および非対称キーで構成されていると定義しています。対称キーと非対称キーの構造は、本質的に同じです。「コンテナ」内の「リスト」です。
* For asymmetric keys, each "asymmetric-key" uses the "asymmetric-key-pair-with-certs-grouping" grouping discussed in Section 2.1.4.12 of [RFC9640].
* 非対称キーの場合、それぞれの「非対称」は、[RFC9640]のセクション2.1.4.12で説明されている「非対称のキーペアと洞窟グループ」グループを使用します。
* For symmetric keys, each "symmetric-key" uses the "symmetric-key-grouping" grouping discussed in Section 2.1.4.3 of [RFC9640].
* 対称キーの場合、それぞれの「対称キー」は、[RFC9640]のセクション2.1.4.3で説明した「対称キーグループ」グループ化を使用します。
The following tree diagram [RFC8340] lists all the protocol-accessible nodes defined in the "ietf-keystore" module without expanding the "grouping" statements:
次のツリー図[RFC8340]に、「グループ化」ステートメントを拡張せずに「IETFキーストア」モジュールで定義されているすべてのプロトコルアクセス可能なノードを示します。
module: ietf-keystore
+--rw keystore {central-keystore-supported}?
+---u keystore-grouping
The following tree diagram [RFC8340] lists all the protocol-accessible nodes defined in the "ietf-keystore" module, with all "grouping" statements expanded, enabling the keystore's full structure to be seen.
次のツリー図[RFC8340]には、「IETFキーストア」モジュールで定義されているすべてのプロトコルアクセス可能なノードをリストし、すべての「グループ化」ステートメントが拡張され、キーストアの完全な構造が見えるようになります。
=============== NOTE: '\' line wrapping per RFC 8792 ================
module: ietf-keystore
+--rw keystore {central-keystore-supported}?
+--rw asymmetric-keys {asymmetric-keys}?
| +--rw asymmetric-key* [name]
| +--rw name string
| +--rw public-key-format? identityref
| +--rw public-key? binary
| +--rw private-key-format? identityref
| +--rw (private-key-type)
| | +--:(cleartext-private-key) {cleartext-private-keys}?
| | | +--rw cleartext-private-key? binary
| | +--:(hidden-private-key) {hidden-private-keys}?
| | | +--rw hidden-private-key? empty
| | +--:(encrypted-private-key) {encrypted-private-keys}?
| | +--rw encrypted-private-key
| | +--rw encrypted-by
| | | +--rw (encrypted-by)
| | | +--:(central-symmetric-key-ref)
| | | | {central-keystore-supported,symme\
tric-keys}?
| | | | +--rw symmetric-key-ref?
| | | | ks:central-symmetric-key-ref
| | | +--:(central-asymmetric-key-ref)
| | | {central-keystore-supported,asymm\
etric-keys}?
| | | +--rw asymmetric-key-ref?
| | | ks:central-asymmetric-key-ref
| | +--rw encrypted-value-format identityref
| | +--rw encrypted-value binary
| +--rw certificates
| | +--rw certificate* [name]
| | +--rw name string
| | +--rw cert-data end-entity-cert-cms
| | +---n certificate-expiration
| | {certificate-expiration-notification}?
| | +-- expiration-date yang:date-and-time
| +---x generate-csr {csr-generation}?
| +---w input
| | +---w csr-format identityref
| | +---w csr-info csr-info
| +--ro output
| +--ro (csr-type)
| +--:(p10-csr)
| +--ro p10-csr? p10-csr
+--rw symmetric-keys {symmetric-keys}?
+--rw symmetric-key* [name]
+--rw name string
+--rw key-format? identityref
+--rw (key-type)
+--:(cleartext-symmetric-key)
| +--rw cleartext-symmetric-key? binary
| {cleartext-symmetric-keys}?
+--:(hidden-symmetric-key) {hidden-symmetric-keys}?
| +--rw hidden-symmetric-key? empty
+--:(encrypted-symmetric-key)
{encrypted-symmetric-keys}?
+--rw encrypted-symmetric-key
+--rw encrypted-by
| +--rw (encrypted-by)
| +--:(central-symmetric-key-ref)
| | {central-keystore-supported,symme\
tric-keys}?
| | +--rw symmetric-key-ref?
| | ks:central-symmetric-key-ref
| +--:(central-asymmetric-key-ref)
| {central-keystore-supported,asymm\
etric-keys}?
| +--rw asymmetric-key-ref?
| ks:central-asymmetric-key-ref
+--rw encrypted-value-format identityref
+--rw encrypted-value binary
Comments:
コメント：
* Protocol-accessible nodes are those nodes that are accessible when the module is "implemented", as described in Section 5.6.5 of [RFC7950].
* プロトコルアクセス可能なノードは、[RFC7950]のセクション5.6.5で説明されているように、モジュールが「実装」されたときにアクセス可能なノードです。
* The protocol-accessible nodes for the "ietf-keystore" module are instances of the "keystore-grouping" grouping discussed in Section 2.1.3.7.
* 「IETFキーストア」モジュールのプロトコルアクセス可能なノードは、セクション2.1.3.7で説明した「キーストアグループ」グループ化のインスタンスです。
* The top-level node "keystore" is additionally constrained by the feature "central-keystore-supported".
* トップレベルのノード「キーストア」は、機能「セントラルキーストアがサポートする」という機能によってさらに制約されています。
* The "keystore-grouping" grouping is discussed in Section 2.1.3.7.
* 「キーストアグループ」グループ化については、セクション2.1.3.7で説明します。
* The reason for why "keystore-grouping" exists separate from the protocol-accessible nodes definition is to enable instances of the keystore to be instantiated in other locations, as may be needed or desired by some modules.
* 「キーストアグループ」がプロトコルにアクセス可能なノード定義とは別に存在する理由は、キーストアのインスタンスが他の場所にインスタンス化され、一部のモジュールが必要または望まれる可能性があることです。
The examples in this section are encoded using XML, such as might be the case when using the NETCONF protocol. Other encodings MAY be used, such as JSON when using the RESTCONF protocol.
このセクションの例は、netConfプロトコルを使用する場合の場合があるように、XMLを使用してエンコードされています。RESTCONFプロトコルを使用する際のJSONなど、他のエンコーディングを使用する場合があります。
The following example illustrates keys in <running>. Please see Section 3 for an example illustrating built-in values in <operational>.
次の例は、<runing>のキーを示しています。<Operational>の内蔵値を示す例については、セクション3を参照してください。
=============== NOTE: '\' line wrapping per RFC 8792 ================
<keystore
xmlns="urn:ietf:params:xml:ns:yang:ietf-keystore"
xmlns:ct="urn:ietf:params:xml:ns:yang:ietf-crypto-types">
<symmetric-keys>
<symmetric-key>
<name>cleartext-symmetric-key</name>
<key-format>ct:octet-string-key-format</key-format>
<cleartext-symmetric-key>BASE64VALUE=</cleartext-symmetric-\
key>
</symmetric-key>
<symmetric-key>
<name>hidden-symmetric-key</name>
<hidden-symmetric-key/>
</symmetric-key>
<symmetric-key>
<name>encrypted-symmetric-key</name>
<key-format>ct:one-symmetric-key-format</key-format>
<encrypted-symmetric-key>
<encrypted-by>
<asymmetric-key-ref>hidden-asymmetric-key</asymmetric-k\
ey-ref>
</encrypted-by>
<encrypted-value-format>ct:cms-enveloped-data-format</enc\
rypted-value-format>
<encrypted-value>BASE64VALUE=</encrypted-value>
</encrypted-symmetric-key>
</symmetric-key>
</symmetric-keys>
<asymmetric-keys>
<asymmetric-key>
<name>ssh-rsa-key</name>
<private-key-format>ct:rsa-private-key-format</private-key-\
format>
<cleartext-private-key>BASE64VALUE=</cleartext-private-key>
</asymmetric-key>
<asymmetric-key>
<name>ssh-rsa-key-with-cert</name>
<private-key-format>ct:rsa-private-key-format</private-key-\
format>
<cleartext-private-key>BASE64VALUE=</cleartext-private-key>
<certificates>
<certificate>
<name>ex-rsa-cert2</name>
<cert-data>BASE64VALUE=</cert-data>
</certificate>
</certificates>
</asymmetric-key>
<asymmetric-key>
<name>raw-private-key</name>
<private-key-format>ct:rsa-private-key-format</private-key-\
format>
<cleartext-private-key>BASE64VALUE=</cleartext-private-key>
</asymmetric-key>
<asymmetric-key>
<name>rsa-asymmetric-key</name>
<private-key-format>ct:rsa-private-key-format</private-key-\
format>
<cleartext-private-key>BASE64VALUE=</cleartext-private-key>
<certificates>
<certificate>
<name>ex-rsa-cert</name>
<cert-data>BASE64VALUE=</cert-data>
</certificate>
</certificates>
</asymmetric-key>
<asymmetric-key>
<name>ec-asymmetric-key</name>
<private-key-format>ct:ec-private-key-format</private-key-f\
ormat>
<cleartext-private-key>BASE64VALUE=</cleartext-private-key>
<certificates>
<certificate>
<name>ex-ec-cert</name>
<cert-data>BASE64VALUE=</cert-data>
</certificate>
</certificates>
</asymmetric-key>
<asymmetric-key>
<name>hidden-asymmetric-key</name>
<public-key-format>ct:subject-public-key-info-format</publi\
c-key-format>
<public-key>BASE64VALUE=</public-key>
<hidden-private-key/>
<certificates>
<certificate>
<name>builtin-idevid-cert</name>
<cert-data>BASE64VALUE=</cert-data>
</certificate>
<certificate>
<name>my-ldevid-cert</name>
<cert-data>BASE64VALUE=</cert-data>
</certificate>
</certificates>
</asymmetric-key>
<asymmetric-key>
<name>encrypted-asymmetric-key</name>
<private-key-format>ct:one-asymmetric-key-format</private-k\
ey-format>
<encrypted-private-key>
<encrypted-by>
<symmetric-key-ref>encrypted-symmetric-key</symmetric-k\
ey-ref>
</encrypted-by>
<encrypted-value-format>ct:cms-encrypted-data-format</enc\
rypted-value-format>
<encrypted-value>BASE64VALUE=</encrypted-value>
</encrypted-private-key>
</asymmetric-key>
</asymmetric-keys>
</keystore>
The following example illustrates a "certificate-expiration" notification for a certificate associated with an asymmetric key configured in the keystore.
次の例は、キーストアで構成された非対称キーに関連付けられている証明書の「証明書の認定」通知を示しています。
=============== NOTE: '\' line wrapping per RFC 8792 ================
<notification
xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0">
<eventTime>2018-05-25T00:01:00Z</eventTime>
<keystore xmlns="urn:ietf:params:xml:ns:yang:ietf-keystore">
<asymmetric-keys>
<asymmetric-key>
<name>hidden-asymmetric-key</name>
<certificates>
<certificate>
<name>my-ldevid-cert</name>
<certificate-expiration>
<expiration-date>2018-08-05T14:18:53-05:00</expiration\
-date>
</certificate-expiration>
</certificate>
</certificates>
</asymmetric-key>
</asymmetric-keys>
</keystore>
</notification>
This section illustrates the various "inline-or-keystore" groupings defined in the "ietf-keystore" module, specifically the "inline-or-keystore-symmetric-key-grouping" (Section 2.1.3.3), "inline-or-keystore-asymmetric-key-grouping" (Section 2.1.3.4), "inline-or-keystore-asymmetric-key-with-certs-grouping" (Section 2.1.3.5), and "inline-or-keystore-end-entity-cert-with-key-grouping" (Section 2.1.3.6) groupings.
このセクションでは、「IETF-Keystore」モジュールで定義されているさまざまな「インラインまたはキーストア」グループ、特に「インラインまたはキーストアセクリックキーグループ」（セクション2.1.3.3）、「インラインオアオア」Keystore-Asymmetric-Key-Grouping "（セクション2.1.3.4）、「インラインオアキーストアアジメトリックキーと礼儀作法」（セクション2.1.3.5）、および「インラインまたはキーストアエンティティ-cert-with-key-grouping "（セクション2.1.3.6）グループ。
These examples assume the existence of an example module called "ex-keystore-usage" that has the namespace "https://example.com/ns/ example-keystore-usage".
これらの例は、名前空間「https://example.com/ns/ example-keystore-usage」を持つ「ex-keystore-usage」と呼ばれるモジュールの例の存在を想定しています。
The ex-keystore-usage module is first presented using tree diagrams [RFC8340], followed by an instance example illustrating all the "inline-or-keystore" groupings in use, followed by the YANG module itself.
Ex-Keystore-Usageモジュールは、最初にツリー図[RFC8340]を使用して提示され、その後に使用されているすべての「インラインまたはキーストア」グループを示すインスタンス例が続き、Yangモジュール自体が続きます。
The following tree diagram illustrates "ex-keystore-usage" without expanding the "grouping" statements:
次のツリー図は、「グループ化」ステートメントを拡張せずに「ex-keystore-usage」を示しています。
=============== NOTE: '\' line wrapping per RFC 8792 ================
module: ex-keystore-usage
+--rw keystore-usage
+--rw symmetric-key* [name]
| +--rw name string
| +---u ks:inline-or-keystore-symmetric-key-grouping
+--rw asymmetric-key* [name]
| +--rw name string
| +---u ks:inline-or-keystore-asymmetric-key-grouping
+--rw asymmetric-key-with-certs* [name]
| +--rw name
| | string
| +---u ks:inline-or-keystore-asymmetric-key-with-certs-groupi\
ng
+--rw end-entity-cert-with-key* [name]
+--rw name
| string
+---u ks:inline-or-keystore-end-entity-cert-with-key-grouping
The following tree diagram illustrates the "ex-keystore-usage" module with all "grouping" statements expanded, enabling the usage's full structure to be seen:
次のツリー図は、すべての「グループ化」ステートメントが拡張された「Ex-Keystore-Usage」モジュールを示しています。
=============== NOTE: '\' line wrapping per RFC 8792 ================
module: ex-keystore-usage
+--rw keystore-usage
+--rw symmetric-key* [name]
| +--rw name string
| +--rw (inline-or-keystore)
| +--:(inline) {inline-definitions-supported}?
| | +--rw inline-definition
| | +--rw key-format? identityref
| | +--rw (key-type)
| | +--:(cleartext-symmetric-key)
| | | +--rw cleartext-symmetric-key? binary
| | | {cleartext-symmetric-keys}?
| | +--:(hidden-symmetric-key)
| | | {hidden-symmetric-keys}?
| | | +--rw hidden-symmetric-key? empty
| | +--:(encrypted-symmetric-key)
| | {encrypted-symmetric-keys}?
| | +--rw encrypted-symmetric-key
| | +--rw encrypted-by
| | +--rw encrypted-value-format identityref
| | +--rw encrypted-value binary
| +--:(central-keystore)
| {central-keystore-supported,symmetric-keys}?
| +--rw central-keystore-reference?
| ks:central-symmetric-key-ref
+--rw asymmetric-key* [name]
| +--rw name string
| +--rw (inline-or-keystore)
| +--:(inline) {inline-definitions-supported}?
| | +--rw inline-definition
| | +--rw public-key-format? identityref
| | +--rw public-key? binary
| | +--rw private-key-format? identityref
| | +--rw (private-key-type)
| | +--:(cleartext-private-key)
| | | {cleartext-private-keys}?
| | | +--rw cleartext-private-key? binary
| | +--:(hidden-private-key) {hidden-private-keys}?
| | | +--rw hidden-private-key? empty
| | +--:(encrypted-private-key)
| | {encrypted-private-keys}?
| | +--rw encrypted-private-key
| | +--rw encrypted-by
| | +--rw encrypted-value-format identityref
| | +--rw encrypted-value binary
| +--:(central-keystore)
| {central-keystore-supported,asymmetric-keys}?
| +--rw central-keystore-reference?
| ks:central-asymmetric-key-ref
+--rw asymmetric-key-with-certs* [name]
| +--rw name string
| +--rw (inline-or-keystore)
| +--:(inline) {inline-definitions-supported}?
| | +--rw inline-definition
| | +--rw public-key-format? identityref
| | +--rw public-key? binary
| | +--rw private-key-format? identityref
| | +--rw (private-key-type)
| | | +--:(cleartext-private-key)
| | | | {cleartext-private-keys}?
| | | | +--rw cleartext-private-key? binary
| | | +--:(hidden-private-key) {hidden-private-keys}?
| | | | +--rw hidden-private-key? empty
| | | +--:(encrypted-private-key)
| | | {encrypted-private-keys}?
| | | +--rw encrypted-private-key
| | | +--rw encrypted-by
| | | +--rw encrypted-value-format identityref
| | | +--rw encrypted-value binary
| | +--rw certificates
| | | +--rw certificate* [name]
| | | +--rw name string
| | | +--rw cert-data
| | | | end-entity-cert-cms
| | | +---n certificate-expiration
| | | {certificate-expiration-notification}?
| | | +-- expiration-date yang:date-and-time
| | +---x generate-csr {csr-generation}?
| | +---w input
| | | +---w csr-format identityref
| | | +---w csr-info csr-info
| | +--ro output
| | +--ro (csr-type)
| | +--:(p10-csr)
| | +--ro p10-csr? p10-csr
| +--:(central-keystore)
| {central-keystore-supported,asymmetric-keys}?
| +--rw central-keystore-reference?
| ks:central-asymmetric-key-ref
+--rw end-entity-cert-with-key* [name]
+--rw name string
+--rw (inline-or-keystore)
+--:(inline) {inline-definitions-supported}?
| +--rw inline-definition
| +--rw public-key-format? identityref
| +--rw public-key? binary
| +--rw private-key-format? identityref
| +--rw (private-key-type)
| | +--:(cleartext-private-key)
| | | {cleartext-private-keys}?
| | | +--rw cleartext-private-key? binary
| | +--:(hidden-private-key) {hidden-private-keys}?
| | | +--rw hidden-private-key? empty
| | +--:(encrypted-private-key)
| | {encrypted-private-keys}?
| | +--rw encrypted-private-key
| | +--rw encrypted-by
| | +--rw encrypted-value-format identityref
| | +--rw encrypted-value binary
| +--rw cert-data?
| | end-entity-cert-cms
| +---n certificate-expiration
| | {certificate-expiration-notification}?
| | +-- expiration-date yang:date-and-time
| +---x generate-csr {csr-generation}?
| +---w input
| | +---w csr-format identityref
| | +---w csr-info csr-info
| +--ro output
| +--ro (csr-type)
| +--:(p10-csr)
| +--ro p10-csr? p10-csr
+--:(central-keystore)
{central-keystore-supported,asymmetric-keys}?
+--rw central-keystore-reference
+--rw asymmetric-key?
| ks:central-asymmetric-key-ref
| {central-keystore-supported,asymmetric-keys\
}?
+--rw certificate? leafref
The following example provides two equivalent instances of each grouping, the first being a reference to a keystore and the second being inlined. The instance having a reference to a keystore is consistent with the keystore defined in Section 2.2.1. The two instances are equivalent, as the inlined instance example contains the same values defined by the keystore instance referenced by its sibling example.
次の例は、各グループの2つの同等のインスタンスを提供します。1つ目はキーストアへの参照であり、2つ目はインラインドされています。キーストアへの参照を持つインスタンスは、セクション2.2.1で定義されているキーストアと一致しています。インラインドインスタンスの例には、兄弟の例が参照するキーストアインスタンスで定義された同じ値が含まれているため、2つのインスタンスは同等です。
=============== NOTE: '\' line wrapping per RFC 8792 ================
<keystore-usage
xmlns="https://example.com/ns/example-keystore-usage"
xmlns:ct="urn:ietf:params:xml:ns:yang:ietf-crypto-types">
<!-- The following two equivalent examples illustrate the -->
<!-- "inline-or-keystore-symmetric-key-grouping" grouping: -->
<symmetric-key>
<name>example 1a</name>
<central-keystore-reference>cleartext-symmetric-key</central-key\
store-reference>
</symmetric-key>
<symmetric-key>
<name>example 1b</name>
<inline-definition>
<key-format>ct:octet-string-key-format</key-format>
<cleartext-symmetric-key>BASE64VALUE=</cleartext-symmetric-key>
</inline-definition>
</symmetric-key>
<!-- The following two equivalent examples illustrate the -->
<!-- "inline-or-keystore-asymmetric-key-grouping" grouping: -->
<asymmetric-key>
<name>example 2a</name>
<central-keystore-reference>rsa-asymmetric-key</central-keystore\
-reference>
</asymmetric-key>
<asymmetric-key>
<name>example 2b</name>
<inline-definition>
<public-key-format>ct:subject-public-key-info-format</public-k\
ey-format>
<public-key>BASE64VALUE=</public-key>
<private-key-format>ct:rsa-private-key-format</private-key-for\
mat>
<cleartext-private-key>BASE64VALUE=</cleartext-private-key>
</inline-definition>
</asymmetric-key>
<!-- The following two equivalent examples illustrate the -->
<!-- "inline-or-keystore-asymmetric-key-with-certs-grouping" -->
<!-- grouping: -->
<asymmetric-key-with-certs>
<name>example 3a</name>
<central-keystore-reference>rsa-asymmetric-key</central-keystore\
-reference>
</asymmetric-key-with-certs>
<asymmetric-key-with-certs>
<name>example 3b</name>
<inline-definition>
<public-key-format>ct:subject-public-key-info-format</public-k\
ey-format>
<public-key>BASE64VALUE=</public-key>
<private-key-format>ct:rsa-private-key-format</private-key-for\
mat>
<cleartext-private-key>BASE64VALUE=</cleartext-private-key>
<certificates>
<certificate>
<name>a locally defined cert</name>
<cert-data>BASE64VALUE=</cert-data>
</certificate>
</certificates>
</inline-definition>
</asymmetric-key-with-certs>
<!-- The following two equivalent examples illustrate the -->
<!-- "inline-or-keystore-end-entity-cert-with-key-grouping" -->
<!-- grouping: -->
<end-entity-cert-with-key>
<name>example 4a</name>
<central-keystore-reference>
<asymmetric-key>rsa-asymmetric-key</asymmetric-key>
<certificate>ex-rsa-cert</certificate>
</central-keystore-reference>
</end-entity-cert-with-key>
<end-entity-cert-with-key>
<name>example 4b</name>
<inline-definition>
<public-key-format>ct:subject-public-key-info-format</public-k\
ey-format>
<public-key>BASE64VALUE=</public-key>
<private-key-format>ct:rsa-private-key-format</private-key-for\
mat>
<cleartext-private-key>BASE64VALUE=</cleartext-private-key>
<cert-data>BASE64VALUE=</cert-data>
</inline-definition>
</end-entity-cert-with-key>
</keystore-usage>
Following is the "ex-keystore-usage" module's YANG definition:
以下は、「Ex-Keystore-Usage」モジュールのYang定義です。
module ex-keystore-usage {
yang-version 1.1;
namespace "https://example.com/ns/example-keystore-usage";
prefix ex-keystore-usage;
import ietf-keystore {
prefix ks;
reference
"RFC 9642: A YANG Data Model for a Keystore";
}
organization
"Example Corporation";
contact
"Author: YANG Designer <mailto:yang.designer@example.com>";
description
"This example module illustrates notable groupings defined
in the 'ietf-keystore' module.";
revision 2024-10-10 {
description
"Initial version";
reference
"RFC 9642: A YANG Data Model for a Keystore";
}
container keystore-usage {
description
"An illustration of the various keystore groupings.";
list symmetric-key {
key "name";
leaf name {
type string;
description
"An arbitrary name for this key.";
}
uses ks:inline-or-keystore-symmetric-key-grouping;
description
"An symmetric key that may be configured locally or be a
reference to a symmetric key in the keystore.";
}
list asymmetric-key {
key "name";
leaf name {
type string;
description
"An arbitrary name for this key.";
}
uses ks:inline-or-keystore-asymmetric-key-grouping;
description
"An asymmetric key, with no certs, that may be configured
locally or be a reference to an asymmetric key in the
keystore. The intent is to reference just the asymmetric
key, not any certificates that may also be associated
with the asymmetric key.";
}
list asymmetric-key-with-certs {
key "name";
leaf name {
type string;
description
"An arbitrary name for this key.";
}
uses ks:inline-or-keystore-asymmetric-key-with-certs-grouping;
description
"An asymmetric key and its associated certs that may be
configured locally or be a reference to an asymmetric
key (and its associated certs) in the keystore.";
}
list end-entity-cert-with-key {
key "name";
leaf name {
type string;
description
"An arbitrary name for this key.";
}
uses ks:inline-or-keystore-end-entity-cert-with-key-grouping;
description
"An end-entity certificate and its associated asymmetric
key that may be configured locally or be a reference
to another certificate (and its associated asymmetric
key) in the keystore.";
}
}
}
This YANG module has normative references to [RFC8341] and [RFC9640].
このYangモジュールには、[RFC8341]および[RFC9640]への規範的な参照があります。
module ietf-keystore {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-keystore";
prefix ks;
import ietf-netconf-acm {
prefix nacm;
reference
"RFC 8341: Network Configuration Access Control Model";
}
import ietf-crypto-types {
prefix ct;
reference
"RFC 9640: YANG Data Types and Groupings for Cryptography";
}
organization
"IETF NETCONF (Network Configuration) Working Group";
contact
"WG Web: https://datatracker.ietf.org/wg/netconf
WG List: NETCONF WG list <mailto:netconf@ietf.org>
Author: Kent Watsen <mailto:kent+ietf@watsen.net>";
description
"This module defines a 'keystore' to centralize management
of security credentials.
The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL',
'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED',
'NOT RECOMMENDED', 'MAY', and 'OPTIONAL' in this document
are to be interpreted as described in BCP 14 (RFC 2119)
(RFC 8174) when, and only when, they appear in all
capitals, as shown here.
Copyright (c) 2024 IETF Trust and the persons identified
as authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with
or without modification, is permitted pursuant to, and
subject to the license terms contained in, the Revised
BSD License set forth in Section 4.c of the IETF Trust's
Legal Provisions Relating to IETF Documents
(https://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC 9642
(https://www.rfc-editor.org/info/rfc9642); see the RFC
itself for full legal notices.";
revision 2024-10-10 {
description
"Initial version";
reference
"RFC 9642: A YANG Data Model for a Keystore";
}
/****************/
/* Features */
/****************/
feature central-keystore-supported {
description
"The 'central-keystore-supported' feature indicates that
the server supports the central keystore (i.e., fully
implements the 'ietf-keystore' module).";
}
feature inline-definitions-supported {
description
"The 'inline-definitions-supported' feature indicates that
the server supports locally defined keys.";
}
feature asymmetric-keys {
description
"The 'asymmetric-keys' feature indicates that the server
implements the /keystore/asymmetric-keys subtree.";
}
feature symmetric-keys {
description
"The 'symmetric-keys' feature indicates that the server
implements the /keystore/symmetric-keys subtree.";
}
/****************/
/* Typedefs */
/****************/
typedef central-symmetric-key-ref {
type leafref {
path "/ks:keystore/ks:symmetric-keys/ks:symmetric-key"
+ "/ks:name";
}
description
"This typedef enables modules to easily define a reference
to a symmetric key stored in the central keystore.";
}
typedef central-asymmetric-key-ref {
type leafref {
path "/ks:keystore/ks:asymmetric-keys/ks:asymmetric-key"
+ "/ks:name";
}
description
"This typedef enables modules to easily define a reference
to an asymmetric key stored in the central keystore.";
}
/*****************/
/* Groupings */
/*****************/
grouping encrypted-by-grouping {
description
"A grouping that defines a 'choice' statement that can be
augmented into the 'encrypted-by' node, present in the
'symmetric-key-grouping' and 'asymmetric-key-pair-grouping'
groupings defined in RFC 9640, enabling references to keys
in the central keystore.";
choice encrypted-by {
nacm:default-deny-write;
mandatory true;
description
"A choice amongst other symmetric or asymmetric keys.";
case central-symmetric-key-ref {
if-feature "central-keystore-supported";
if-feature "symmetric-keys";
leaf symmetric-key-ref {
type ks:central-symmetric-key-ref;
description
"Identifies the symmetric key used to encrypt the
associated key.";
}
}
case central-asymmetric-key-ref {
if-feature "central-keystore-supported";
if-feature "asymmetric-keys";
leaf asymmetric-key-ref {
type ks:central-asymmetric-key-ref;
description
"Identifies the asymmetric key whose public key
encrypted the associated key.";
}
}
}
}
// *-ref groupings
grouping central-asymmetric-key-certificate-ref-grouping {
description
"A grouping for the reference to a certificate associated
with an asymmetric key stored in the central keystore.";
leaf asymmetric-key {
nacm:default-deny-write;
if-feature "central-keystore-supported";
if-feature "asymmetric-keys";
type ks:central-asymmetric-key-ref;
must '../certificate';
description
"A reference to an asymmetric key in the keystore.";
}
leaf certificate {
nacm:default-deny-write;
type leafref {
path "/ks:keystore/ks:asymmetric-keys/ks:asymmetric-key"
+ "[ks:name = current()/../asymmetric-key]/"
+ "ks:certificates/ks:certificate/ks:name";
}
must '../asymmetric-key';
description
"A reference to a specific certificate of the
asymmetric key in the keystore.";
}
}
// inline-or-keystore-* groupings
grouping inline-or-keystore-symmetric-key-grouping {
description
"A grouping for the configuration of a symmetric key. The
symmetric key may be defined inline or as a reference to
a symmetric key stored in the central keystore.
Servers that wish to define alternate keystore locations
SHOULD augment in custom 'case' statements enabling
references to those alternate keystore locations.";
choice inline-or-keystore {
nacm:default-deny-write;
mandatory true;
description
"A choice between an inlined definition and a definition
that exists in the keystore.";
case inline {
if-feature "inline-definitions-supported";
container inline-definition {
description
"A container to hold the local key definition.";
uses ct:symmetric-key-grouping;
}
}
case central-keystore {
if-feature "central-keystore-supported";
if-feature "symmetric-keys";
leaf central-keystore-reference {
type ks:central-symmetric-key-ref;
description
"A reference to a symmetric key that exists in
the central keystore.";
}
}
}
}
grouping inline-or-keystore-asymmetric-key-grouping {
description
"A grouping for the configuration of an asymmetric key. The
asymmetric key may be defined inline or as a reference to
an asymmetric key stored in the central keystore.
Servers that wish to define alternate keystore locations
SHOULD augment in custom 'case' statements enabling
references to those alternate keystore locations.";
choice inline-or-keystore {
nacm:default-deny-write;
mandatory true;
description
"A choice between an inlined definition and a definition
that exists in the keystore.";
case inline {
if-feature "inline-definitions-supported";
container inline-definition {
description
"A container to hold the local key definition.";
uses ct:asymmetric-key-pair-grouping;
}
}
case central-keystore {
if-feature "central-keystore-supported";
if-feature "asymmetric-keys";
leaf central-keystore-reference {
type ks:central-asymmetric-key-ref;
description
"A reference to an asymmetric key that exists in
the central keystore. The intent is to reference
just the asymmetric key without any regard for
any certificates that may be associated with it.";
}
}
}
}
grouping inline-or-keystore-asymmetric-key-with-certs-grouping {
description
"A grouping for the configuration of an asymmetric key and
its associated certificates. The asymmetric key and its
associated certificates may be defined inline or as a
reference to an asymmetric key (and its associated
certificates) in the central keystore.
Servers that wish to define alternate keystore locations
SHOULD augment in custom 'case' statements enabling
references to those alternate keystore locations.";
choice inline-or-keystore {
nacm:default-deny-write;
mandatory true;
description
"A choice between an inlined definition and a definition
that exists in the keystore.";
case inline {
if-feature "inline-definitions-supported";
container inline-definition {
description
"A container to hold the local key definition.";
uses ct:asymmetric-key-pair-with-certs-grouping;
}
}
case central-keystore {
if-feature "central-keystore-supported";
if-feature "asymmetric-keys";
leaf central-keystore-reference {
type ks:central-asymmetric-key-ref;
description
"A reference to an asymmetric key (and all of its
associated certificates) in the keystore, when
this module is implemented.";
}
}
}
}
grouping inline-or-keystore-end-entity-cert-with-key-grouping {
description
"A grouping for the configuration of an asymmetric key and
its associated end-entity certificate. The asymmetric key
and its associated end-entity certificate may be defined
inline or as a reference to an asymmetric key (and its
associated end-entity certificate) in the central keystore.
Servers that wish to define alternate keystore locations
SHOULD augment in custom 'case' statements enabling
references to those alternate keystore locations.";
choice inline-or-keystore {
nacm:default-deny-write;
mandatory true;
description
"A choice between an inlined definition and a definition
that exists in the keystore.";
case inline {
if-feature "inline-definitions-supported";
container inline-definition {
description
"A container to hold the local key definition.";
uses ct:asymmetric-key-pair-with-cert-grouping;
}
}
case central-keystore {
if-feature "central-keystore-supported";
if-feature "asymmetric-keys";
container central-keystore-reference {
uses central-asymmetric-key-certificate-ref-grouping;
description
"A reference to a specific certificate associated with
an asymmetric key stored in the central keystore.";
}
}
}
}
// the keystore grouping
grouping keystore-grouping {
description
"A grouping definition enables use in other contexts. If ever
done, implementations MUST augment new 'case' statements
into the various inline-or-keystore 'choice' statements to
supply leafrefs to the model-specific location(s).";
container asymmetric-keys {
nacm:default-deny-write;
if-feature "asymmetric-keys";
description
"A list of asymmetric keys.";
list asymmetric-key {
key "name";
description
"An asymmetric key.";
leaf name {
type string;
description
"An arbitrary name for the asymmetric key.";
}
uses ct:asymmetric-key-pair-with-certs-grouping;
}
}
container symmetric-keys {
nacm:default-deny-write;
if-feature "symmetric-keys";
description
"A list of symmetric keys.";
list symmetric-key {
key "name";
description
"A symmetric key.";
leaf name {
type string;
description
"An arbitrary name for the symmetric key.";
}
uses ct:symmetric-key-grouping;
}
}
}
/*********************************/
/* Protocol accessible nodes */
/*********************************/
container keystore {
if-feature "central-keystore-supported";
description
"A central keystore containing a list of symmetric keys and
a list of asymmetric keys.";
nacm:default-deny-write;
uses keystore-grouping {
augment "symmetric-keys/symmetric-key/key-type/encrypted-"
+ "symmetric-key/encrypted-symmetric-key/encrypted-by" {
description
"Augments in a choice statement enabling the encrypting
key to be any other symmetric or asymmetric key in the
central keystore.";
uses encrypted-by-grouping;
}
augment "asymmetric-keys/asymmetric-key/private-key-type/"
+ "encrypted-private-key/encrypted-private-key/"
+ "encrypted-by" {
description
"Augments in a choice statement enabling the encrypting
key to be any other symmetric or asymmetric key in the
central keystore.";
uses encrypted-by-grouping;
}
}
}
}
In some implementations, a server may support keys built into the server. Built-in keys MAY be set during the manufacturing process or be dynamically generated the first time the server is booted or a particular service (e.g., Secure Shell (SSH)) is enabled.
いくつかの実装では、サーバーがサーバーに組み込まれたキーをサポートする場合があります。ビルトインキーは、製造プロセス中に設定されたり、サーバーが起動されたり、特定のサービス（セキュアシェル（SSH）など）が有効になったときに動的に生成されます。
Built-in keys are "hidden" keys expected to be set by a vendor-specific process. Any ability for operators to set and/or modify built-in keys is outside the scope of this document.
内蔵キーは、ベンダー固有のプロセスによって設定されると予想される「隠された」キーです。オペレーターが組み込みキーを設定および/または変更する能力は、このドキュメントの範囲外です。
The primary characteristic of the built-in keys is that they are provided by the server, as opposed to being configured. As such, they are present in <operational> (Section 5.3 of [RFC8342]) and <system> [NETMOD-SYSTEM-CONFIG], if implemented.
組み込みキーの主な特徴は、構成とは対照的に、サーバーによって提供されることです。そのため、実装されている場合、<操作>（[RFC8342]のセクション5.3）および<System> [NetMod-System-Config]に存在します。
The example below illustrates what the keystore in <operational> might look like for a server in its factory default state. Note that the built-in keys have the "or:origin" annotation value "or:system".
以下の例は、工場出荷時のデフォルト状態のサーバーのキーストアがどのように見えるかを示しています。組み込みのキーには、「OR：ORIGIN「注釈」または：システム」があることに注意してください。
=============== NOTE: '\' line wrapping per RFC 8792 ================
<keystore xmlns="urn:ietf:params:xml:ns:yang:ietf-keystore"
xmlns:ct="urn:ietf:params:xml:ns:yang:ietf-crypto-types"
xmlns:or="urn:ietf:params:xml:ns:yang:ietf-origin"
or:origin="or:intended">
<asymmetric-keys>
<asymmetric-key or:origin="or:system">
<name>Manufacturer-Generated Hidden Key</name>
<public-key-format>ct:subject-public-key-info-format</public-k\
ey-format>
<public-key>BASE64VALUE=</public-key>
<hidden-private-key/>
<certificates>
<certificate>
<name>Manufacturer-Generated IDevID Cert</name>
<cert-data>BASE64VALUE=</cert-data>
</certificate>
</certificates>
</asymmetric-key>
</asymmetric-keys>
</keystore>
The following example illustrates how a single built-in key definition from the previous example has been propagated to <running>:
次の例は、前の例から単一の組み込みのキー定義が<runing>に伝播された方法を示しています。
=============== NOTE: '\' line wrapping per RFC 8792 ================
<keystore xmlns="urn:ietf:params:xml:ns:yang:ietf-keystore"
xmlns:ct="urn:ietf:params:xml:ns:yang:ietf-crypto-types">
<asymmetric-keys>
<asymmetric-key>
<name>Manufacturer-Generated Hidden Key</name>
<public-key-format>ct:subject-public-key-info-format</public-k\
ey-format>
<public-key>BASE64VALUE=</public-key>
<hidden-private-key/>
<certificates>
<certificate>
<name>Manufacturer-Generated IDevID Cert</name>
<cert-data>BASE64VALUE=</cert-data>
</certificate>
<certificate>
<name>Deployment-Specific LDevID Cert</name>
<cert-data>BASE64VALUE=</cert-data>
</certificate>
</certificates>
</asymmetric-key>
</asymmetric-keys>
</keystore>
After the above configuration is applied, <operational> should appear as follows:
上記の構成が適用された後、<操作>は次のように表示されます。
=============== NOTE: '\' line wrapping per RFC 8792 ================
<keystore xmlns="urn:ietf:params:xml:ns:yang:ietf-keystore"
xmlns:ct="urn:ietf:params:xml:ns:yang:ietf-crypto-types"
xmlns:or="urn:ietf:params:xml:ns:yang:ietf-origin"
or:origin="or:intended">
<asymmetric-keys>
<asymmetric-key or:origin="or:system">
<name>Manufacturer-Generated Hidden Key</name>
<public-key-format>ct:subject-public-key-info-format</public-k\
ey-format>
<public-key>BASE64VALUE=</public-key>
<hidden-private-key/>
<certificates>
<certificate>
<name>Manufacturer-Generated IDevID Cert</name>
<cert-data>BASE64VALUE=</cert-data>
</certificate>
<certificate or:origin="or:intended">
<name>Deployment-Specific LDevID Cert</name>
<cert-data>BASE64VALUE=</cert-data>
</certificate>
</certificates>
</asymmetric-key>
</asymmetric-keys>
</keystore>
This section describes an approach that enables both the symmetric and asymmetric keys on a server to be encrypted, such that backup/ restore procedures can be used without concern for raw key data being compromised when in transit.
このセクションでは、サーバー上の対称キーと非対称キーの両方を暗号化できるようにするアプローチについて説明します。これにより、バックアップ/復元手順は、輸送中に生のキーデータが侵害されることを懸念なく使用できます。
The approach presented in this section is not normative. This section answers how a configuration containing secrets that are encrypted by a built-in key (Section 3) can be backed up from one server and restored on a different server when each server has unique primary keys. The API defined by the "ietf-keystore" YANG module presented in this document is sufficient to support the workflow described in this section.
このセクションで示されているアプローチは規範的ではありません。このセクションは、組み込みのキー（セクション3）によって暗号化された秘密を含む構成が、1つのサーバーからバックアップし、各サーバーに一意のプライマリキーがあるときに別のサーバーで復元する方法に答えます。このドキュメントに示されている「IETFキーストア」Yangモジュールで定義されたAPIは、このセクションで説明するワークフローをサポートするのに十分です。
The ability to encrypt configured keys is predicated on the existence of a key encryption key (KEK). There may be any number of KEKs in a server. A KEK, by its namesake, is a key that is used to encrypt other keys. A KEK MAY be either a symmetric key or an asymmetric key.
構成されたキーを暗号化する機能は、キー暗号化キー（KEK）の存在に基づいています。サーバーには任意の数のKEKがある場合があります。Kekは、その同名で、他のキーを暗号化するために使用されるキーです。KEKは、対称キーまたは非対称キーのいずれかです。
If a KEK is a symmetric key, then the server MUST provide an API for administrators to encrypt other keys without needing to know the symmetric key's value. If the KEK is an asymmetric key, then the server SHOULD provide an API enabling the encryption of other keys or, alternatively, assume the administrators can do so themselves using the asymmetric key's public half.
KEKが対称キーである場合、サーバーは、対称キーの値を知る必要なく、管理者が他のキーを暗号化するためのAPIを提供する必要があります。KEKが非対称キーである場合、サーバーは他のキーの暗号化を可能にするAPIを提供するか、または、非対称キーのパブリックハーフを使用して管理者が自分でできることを想定する必要があります。
A server MUST possess access to the KEK, or an API using the KEK, so that it can decrypt the other keys in the configuration at runtime.
サーバーは、KEKまたはKEKを使用してAPIにアクセスする必要があるため、実行時に構成の他のキーを復号化できるようにする必要があります。
Each time a new key is configured, it SHOULD be encrypted by a KEK.
新しいキーが設定されるたびに、KEKによって暗号化される必要があります。
In the "ietf-crypto-types" module [RFC9640], the format for encrypted values is described by identity statements derived from the "symmetrically-encrypted-value-format" and "asymmetrically-encrypted-value-format" identity statements.
「IETF-CRYPTO-TYPES」モジュール[RFC9640]では、暗号化された値の形式は、「対称的に暗号化された値と価値の形式」と「非対称的に暗号化された値と価値のあるもの」から派生したIDステートメントによって説明されています。
Implementations of servers implementing the "ietf-keystore" module SHOULD provide an API that simultaneously generates a key and encrypts the generated key using a KEK. Thus, the cleartext value of the newly generated key may never be known to the administrators generating the keys. Such an API is defined in the "ietf-ssh-common" and "ietf-tls-common" YANG modules defined in [RFC9644] and [RFC9645], respectively.
「IETFキーストア」モジュールを実装するサーバーの実装は、キーを生成し、KEKを使用して生成されたキーを暗号化するAPIを提供する必要があります。したがって、新しく生成されたキーのクリアテキスト値は、キーを生成する管理者には決して知られていない場合があります。このようなAPIは、それぞれ[RFC9644]および[RFC9645]で定義されている「IETF-SSH-Common」および「IETF-TLS-Common」Yangモジュールで定義されています。
In case the server implementation does not provide such an API, then the generating and encrypting steps MAY be performed outside the server, e.g., by an administrator with special access control rights (such as an organization's crypto officer).
サーバーの実装がそのようなAPIを提供しない場合、特別なアクセス制御権を持つ管理者（組織の暗号担当官など）を持つ管理者によって、サーバーの外側での生成および暗号化ステップを実行できます。
In either case, the encrypted key can be configured into the keystore using either the "encrypted-symmetric-key" (for symmetric keys) or the "encrypted-private-key" (for asymmetric keys) nodes. These two nodes contain both the encrypted raw key value as well as a reference to the KEK that encrypted the key.
いずれの場合も、暗号化されたキーを「暗号化されたサイクルキー」（対称キー用）または「暗号化されたプリベートキー」（非対称キー用）ノードのいずれかを使用してキーストアに構成できます。これらの2つのノードには、暗号化された生のキー値の両方と、キーを暗号化したKEKへの参照の両方が含まれています。
When a KEK is used to encrypt other keys, migrating the configuration to another server is only possible if the second server has the same KEK. How the second server comes to have the same KEK is discussed in this section.
KEKを使用して他のキーを暗号化する場合、2番目のサーバーが同じKEKを持っている場合にのみ、構成を別のサーバーに移行することが可能です。このセクションでは、2番目のサーバーが同じKEKを作成する方法について説明します。
In some deployments, mechanisms outside the scope of this document may be used to migrate a KEK from one server to another. That said, beware that the ability to do so typically entails having access to the first server; however, in some scenarios, the first server may no longer be operational.
一部の展開では、このドキュメントの範囲外のメカニズムを使用して、あるサーバーから別のサーバーにKEKを移行することができます。とはいえ、通常、最初のサーバーにアクセスできることを伴うことに注意してください。ただし、一部のシナリオでは、最初のサーバーが動作しなくなる場合があります。
In other deployments, an organization's crypto officer, possessing a KEK's cleartext value, configures the same KEK on the second server, presumably as a hidden key or a key protected by access control, so that the cleartext value is not disclosed to regular administrators. However, this approach creates high coupling to and dependency on the crypto officers that does not scale in production environments.
他の展開では、KekのClearText値を所有する組織の暗号担当官は、おそらくAccessコントロールによって非表示のキーまたはキーとして同じKEKを構成し、クリアテキスト値が通常の管理者に開示されないように設定します。ただし、このアプローチは、生産環境で規模を拡大しない暗号役員への高い結合と依存を生み出します。
In order to decouple the crypto officers from the regular administrators, a special KEK, called the "primary key" (PK), may be used.
通常の管理者から暗号の役員を切り離すために、「プライマリキー」（PK）と呼ばれる特別なKEKを使用することができます。
A PK is commonly a globally unique built-in (see Section 3) asymmetric key. The private raw key value, due to its long lifetime, is hidden (i.e., "hidden-private-key"; see Section 2.1.4.5. of [RFC9640]). The raw public key value is often contained in an identity certificate (e.g., IDevID). How to configure a PK during the manufacturing process is outside the scope of this document.
PKは一般にグローバルに一意の組み込み（セクション3を参照）非対称キーです。プライベートの生のキー値は、その長い寿命のために隠されています（つまり、「Hidden-Private-Key」。[RFC9640]のセクション2.1.4.5。を参照）。生の公開鍵値は、多くの場合、ID証明書（IDEVIDなど）に含まれています。製造プロセス中にPKを構成する方法は、このドキュメントの範囲外です。
Assuming the server has a PK, the PK can be used to encrypt a "shared KEK", which is then used to encrypt the keys configured by regular administrators.
サーバーにPKがあると仮定すると、PKを使用して「共有Kek」を暗号化し、通常の管理者によって構成されたキーを暗号化するために使用できます。
With this extra level of indirection, it is possible for a crypto officer to encrypt the same KEK for a multiplicity of servers offline using the public key contained in their identity certificates. The crypto officer can then safely hand off the encrypted KEKs to regular administrators responsible for server installations, including migrations.
この余分なレベルの間接的なことにより、暗号士官は、アイデンティティ証明書に含まれる公開キーを使用して、オフラインの多数のサーバーに対して同じKEKを暗号化することができます。暗号の役員は、移行を含むサーバーのインストールを担当する通常の管理者に暗号化されたKEKを安全に引き渡すことができます。
In order to migrate the configuration from a first server, an administrator would need to make just a single modification to the configuration before loading it onto a second server, which is to replace the encrypted KEK keystore entry from the first server with the encrypted KEK for the second server. Upon doing this, the configuration (containing many encrypted keys) can be loaded into the second server while enabling the second server to decrypt all the encrypted keys in the configuration.
最初のサーバーから構成を移行するには、管理者が2番目のサーバーにロードする前に構成に単一の変更を行う必要があります。2番目のサーバー。これを行うと、構成（多くの暗号化されたキーを含む）を2番目のサーバーにロードしながら、2番目のサーバーが構成内のすべての暗号化されたキーを復号化できるようにすることができます。
The following diagram illustrates this idea:
次の図は、このアイデアを示しています。
+-------------+ +-------------+
| shared KEK | | shared KEK |
|(unencrypted)|-------------------------------> | (encrypted) |
+-------------+ encrypts offline using +-------------+
^ each server's PK |
| |
| |
| possesses \o |
+-------------- |\ |
/ \ shares with |
crypto +--------------------+
officer |
|
|
+----------------------+ | +----------------------+
| server-1 | | | server-2 |
| configuration | | | configuration |
| | | | |
| | | | |
| +----------------+ | | | +----------------+ |
| | PK-1 | | | | | PK-2 | |
| | (hidden) | | | | | (hidden) | |
| +----------------+ | | | +----------------+ |
| ^ | | | ^ |
| | | | | | |
| | | | | | |
| | encrypted | | | | encrypted |
| | by | | | | by |
| | | | | | |
| | | | | | |
| +----------------+ | | | +----------------+ |
| | shared KEK | | | | | shared KEK | |
| | (encrypted) | | v | | (encrypted) | |
| +----------------+ | | +----------------+ |
| ^ | regular | ^ |
| | | admin | | |
| | | | | |
| | encrypted | \o | | encrypted |
| | by | |\ | | by |
| | | / \ | | |
| | | | | |
| +----------------+ |----------------->| +----------------+ |
| | all other keys | | migrate | | all other keys | |
| | (encrypted) | | configuration | | (encrypted) | |
| +----------------+ | | +----------------+ |
| | | |
+----------------------+ +----------------------+
The YANG module defined in this document defines a mechanism called a "keystore" that intends to protect its contents from unauthorized disclosure and modification.
このドキュメントで定義されているYangモジュールは、不正な開示と変更からその内容を保護することを目的とした「キーストア」と呼ばれるメカニズムを定義しています。
In order to satisfy the expectations of a keystore, it is RECOMMENDED that server implementations ensure that the keystore contents are encrypted when persisted to non-volatile memory and that the keystore contents that have been decrypted in volatile memory are zeroized when not in use.
キーストアの期待を満たすために、サーバーの実装は、不揮発性メモリに持続するとキーストアの内容が暗号化され、揮発性メモリで復号化されたキーストアの内容が使用されていないときにゼロ化されることを保証することをお勧めします。
The keystore contents may be encrypted by either encrypting the contents individually (e.g., using the "encrypted" value formats) or using persistence-layer-level encryption. If storing cleartext values (which is NOT RECOMMENDED per Section 3.5 of [RFC9640]), then persistence-layer-level encryption SHOULD be used to protect the data at rest.
キーストアのコンテンツは、コンテンツを個別に暗号化する（例えば、「暗号化された」値形式を使用する）、または永続レイヤーレベルの暗号化を使用することによって暗号化される場合があります。ClearText値を保存する場合（[RFC9640]セクション3.5に従って推奨されない）、保持レイヤーレベルの暗号化を使用して、安静時のデータを保護する必要があります。
If the keystore contents are not encrypted when persisted, then server implementations MUST ensure the persisted storage is inaccessible.
キーストアのコンテンツが持続したときに暗号化されていない場合、サーバーの実装は、永続的なストレージにアクセスできないようにする必要があります。
This module enables the configuration of private keys without constraints on their usage, e.g., what operations the key is allowed to be used for (such as signature, decryption, or both).
このモジュールは、使用法を制約することなくプライベートキーの構成を可能にします。たとえば、キーを使用できる操作（署名、復号化、またはその両方など）。
This module also does not constrain the usage of the associated public keys other than in the context of a configured certificate (e.g., an identity certificate), in which case the key usage is constrained by the certificate.
また、このモジュールは、設定された証明書（ID証明書など）のコンテキスト以外の関連するパブリックキーの使用を制約しません。この場合、キーの使用法は証明書によって制約されます。
This section is modeled after the template defined in Section 3.7.1 of [RFC8407].
このセクションは、[RFC8407]のセクション3.7.1で定義されているテンプレートをモデルにしています。
The ietf-keystore YANG module defines a data model that is designed to be accessed via YANG-based management protocols, such as NETCONF [RFC6241] and RESTCONF [RFC8040]. These protocols have mandatory-to-implement secure transport layers (e.g., SSH [RFC4252], TLS [RFC8446], and QUIC [RFC9000]) and mandatory-to-implement mutual authentication.
IETF-Keystore Yangモジュールは、NetConf [RFC6241]やRestConf [RFC8040]などのYangベースの管理プロトコルを介してアクセスするように設計されたデータモデルを定義します。これらのプロトコルには、必須の安全性の安全な輸送層（例：SSH [RFC4252]、TLS [RFC8446]、およびQUIC [RFC9000]）および義務的な相互認証があります。
The Network Configuration Access Control Model (NACM) [RFC8341] provides the means to restrict access for particular users to a preconfigured subset of all available protocol operations and content.
ネットワーク構成アクセス制御モデル（NACM）[RFC8341]は、利用可能なすべてのプロトコル操作とコンテンツの事前に構成されたサブセットへの特定のユーザーのアクセスを制限する手段を提供します。
Please be aware that this YANG module uses groupings from other YANG modules that define nodes that may be considered sensitive or vulnerable in network environments. Please review the Security Considerations for dependent YANG modules for information as to which nodes may be considered sensitive or vulnerable in network environments.
このYangモジュールは、ネットワーク環境で敏感または脆弱と見なされる可能性のあるノードを定義する他のYangモジュールのグループを使用していることに注意してください。ネットワーク環境で敏感または脆弱性と見なされるノードに関する情報については、依存するYangモジュールのセキュリティに関する考慮事項を確認してください。
Some of the readable data nodes in this YANG module may be considered sensitive or vulnerable in some network environments. It is thus important to control read access (e.g., via get, get-config, or notification) to these data nodes. These are the subtrees and data nodes and their sensitivity/vulnerability:
このYangモジュールの読み取り可能なデータノードの一部は、一部のネットワーク環境で敏感または脆弱と見なされる場合があります。したがって、これらのデータノードへの読み取りアクセス（GET、GetConfig、または通知を介して）を制御することが重要です。これらは、サブツリーとデータノードとその感度/脆弱性です。
The "cleartext-symmetric-key" node:
「ClearText-Symmetric-Key」ノード：
This node, imported from the "symmetric-key-grouping" grouping defined in [RFC9640], is additionally sensitive to read operations such that, in normal use cases, it should never be returned to a client. For this reason, the NACM extension "default-deny-all" was applied to it in [RFC9640].
[RFC9640]で定義された「対称キーグループ」グループからインポートされたこのノードは、通常のユースケースではクライアントに返されることはないように、読み取り操作にさらに敏感です。このため、[RFC9640]では、NACM拡張「デフォルトデニーオール」が適用されました。
The "cleartext-private-key" node:
「ClearText-Private-Key」ノード：
This node, defined in the "asymmetric-key-pair-grouping" grouping in [RFC9640], is additionally sensitive to read operations such that, in normal use cases, it should never be returned to a client. For this reason, the NACM extension "default-deny-all" is applied to it in [RFC9640].
[RFC9640]の「非対称キーペアグループ」グループで定義されているこのノードは、通常のユースケースではクライアントに戻さないように、読み取り操作にさらに敏感です。このため、[RFC9640]でNACM拡張「デフォルトデニーオール」が適用されます。
All the writable data nodes defined by this YANG module, both in the "grouping" statements as well as the protocol-accessible "keystore" instance, may be considered sensitive or vulnerable in some network environments. For instance, any modification to a key or reference to a key may dramatically alter the implemented security policy. For this reason, the NACM extension "default-deny-write" has been set for all data nodes defined in this module.
「グループ化」ステートメントとプロトコルにアクセス可能な「キーストア」インスタンスの両方で、このYangモジュールによって定義されたすべての書き込みデータノードは、一部のネットワーク環境で敏感または脆弱と見なされる場合があります。たとえば、キーの変更またはキーへの参照は、実装されたセキュリティポリシーを劇的に変更する場合があります。このため、このモジュールで定義されているすべてのデータノードに対して、NACM拡張「デフォルトデニーワイト」が設定されています。
This YANG module does not define any "rpc" or "action" statements, and thus the security considerations for such is not provided here.
このYangモジュールは、「RPC」または「アクション」ステートメントを定義していないため、ここではセキュリティ上の考慮事項は提供されません。
Built-in key types SHOULD be hidden and/or encrypted (not cleartext). If this is not possible, access control mechanisms like NACM SHOULD be used to limit access to the key's secret data to only the most trusted authorized clients (e.g., belonging to an organization's crypto officer).
組み込みのキータイプは、非表示および/または暗号化する必要があります（ClearTextではなく）。これが不可能な場合、NACMのようなアクセス制御メカニズムを使用して、キーの秘密データへのアクセスを最も信頼できる承認されたクライアントのみ（たとえば、組織の暗号役員に属する）のみに制限する必要があります。
IANA has registered the following URI in the "ns" registry of the "IETF XML Registry" [RFC3688].
IANAは、「IETF XMLレジストリ」[RFC3688]の「NS」レジストリに次のURIを登録しています。
URI:
URI:
urn:ietf:params:xml:ns:yang:ietf-keystore
urn：ietf：params：xml：ns：yang：ietf-keystore
Registrant Contact:
登録者の連絡先：
The IESG
IESG
XML:
XML:
N/A; the requested URI is an XML namespace.
n/a;要求されたURIはXMLネームスペースです。
IANA has registered the following YANG module in the "YANG Module Names" registry defined in [RFC6020].
IANAは、[RFC6020]で定義されている「Yangモジュール名」レジストリに次のYangモジュールを登録しています。
Name:
名前：
ietf-keystore
ietf-keystore
Maintained by IANA:
IANAによって維持されています：
N
n
Namespace:
名前空間：
urn:ietf:params:xml:ns:yang:ietf-keystore
urn：ietf：params：xml：ns：yang：ietf-keystore
Prefix:
プレフィックス：
ks
KS
Reference:
参照：
RFC 9642
RFC 9642
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997,
<https://www.rfc-editor.org/info/rfc2119>.
[RFC4252] Ylonen, T. and C. Lonvick, Ed., "The Secure Shell (SSH)
Authentication Protocol", RFC 4252, DOI 10.17487/RFC4252,
January 2006, <https://www.rfc-editor.org/info/rfc4252>.
[RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for
the Network Configuration Protocol (NETCONF)", RFC 6020,
DOI 10.17487/RFC6020, October 2010,
<https://www.rfc-editor.org/info/rfc6020>.
[RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed.,
and A. Bierman, Ed., "Network Configuration Protocol
(NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011,
<https://www.rfc-editor.org/info/rfc6241>.
[RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language",
RFC 7950, DOI 10.17487/RFC7950, August 2016,
<https://www.rfc-editor.org/info/rfc7950>.
[RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF
Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017,
<https://www.rfc-editor.org/info/rfc8040>.
[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
May 2017, <https://www.rfc-editor.org/info/rfc8174>.
[RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration
Access Control Model", STD 91, RFC 8341,
DOI 10.17487/RFC8341, March 2018,
<https://www.rfc-editor.org/info/rfc8341>.
[RFC8446] Rescorla, E., "The Transport Layer Security (TLS) Protocol
Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018,
<https://www.rfc-editor.org/info/rfc8446>.
[RFC9000] Iyengar, J., Ed. and M. Thomson, Ed., "QUIC: A UDP-Based
Multiplexed and Secure Transport", RFC 9000,
DOI 10.17487/RFC9000, May 2021,
<https://www.rfc-editor.org/info/rfc9000>.
[RFC9640] Watsen, K., "YANG Data Types and Groupings for
Cryptography", RFC 9640, DOI 10.17487/RFC9640, October
2024, <https://www.rfc-editor.org/info/rfc9640>.
[HTTP-CLIENT-SERVER]
Watsen, K., "YANG Groupings for HTTP Clients and HTTP
Servers", Work in Progress, Internet-Draft, draft-ietf-
netconf-http-client-server-23, 15 August 2024,
<https://datatracker.ietf.org/doc/html/draft-ietf-netconf-
http-client-server-23>.
[NETCONF-CLIENT-SERVER]
Watsen, K., "NETCONF Client and Server Models", Work in
Progress, Internet-Draft, draft-ietf-netconf-netconf-
client-server-37, 14 August 2024,
<https://datatracker.ietf.org/doc/html/draft-ietf-netconf-
netconf-client-server-37>.
[NETMOD-SYSTEM-CONFIG]
Ma, Q., Ed., Wu, Q., and C. Feng, "System-defined
Configuration", Work in Progress, Internet-Draft, draft-
ietf-netmod-system-config-09, 29 September 2024,
<https://datatracker.ietf.org/doc/html/draft-ietf-netmod-
system-config-09>.
[RESTCONF-CLIENT-SERVER]
Watsen, K., "RESTCONF Client and Server Models", Work in
Progress, Internet-Draft, draft-ietf-netconf-restconf-
client-server-38, 14 August 2024,
<https://datatracker.ietf.org/doc/html/draft-ietf-netconf-
restconf-client-server-38>.
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
DOI 10.17487/RFC3688, January 2004,
<https://www.rfc-editor.org/info/rfc3688>.
[RFC8259] Bray, T., Ed., "The JavaScript Object Notation (JSON) Data
Interchange Format", STD 90, RFC 8259,
DOI 10.17487/RFC8259, December 2017,
<https://www.rfc-editor.org/info/rfc8259>.
[RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams",
BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018,
<https://www.rfc-editor.org/info/rfc8340>.
[RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K.,
and R. Wilton, "Network Management Datastore Architecture
(NMDA)", RFC 8342, DOI 10.17487/RFC8342, March 2018,
<https://www.rfc-editor.org/info/rfc8342>.
[RFC8407] Bierman, A., "Guidelines for Authors and Reviewers of
Documents Containing YANG Data Models", BCP 216, RFC 8407,
DOI 10.17487/RFC8407, October 2018,
<https://www.rfc-editor.org/info/rfc8407>.
[RFC8792] Watsen, K., Auerswald, E., Farrel, A., and Q. Wu,
"Handling Long Lines in Content of Internet-Drafts and
RFCs", RFC 8792, DOI 10.17487/RFC8792, June 2020,
<https://www.rfc-editor.org/info/rfc8792>.
[RFC9641] Watsen, K., "A YANG Data Model for a Truststore",
RFC 9641, DOI 10.17487/RFC9641, October 2024,
<https://www.rfc-editor.org/info/rfc9641>.
[RFC9643] Watsen, K. and M. Scharf, "YANG Groupings for TCP Clients
and TCP Servers", RFC 9643, DOI 10.17487/RFC9643, October
2024, <https://www.rfc-editor.org/info/rfc9643>.
[RFC9644] Watsen, K., "YANG Groupings for SSH Clients and SSH
Servers", RFC 9644, DOI 10.17487/RFC9644, October 2024,
<https://www.rfc-editor.org/info/rfc9644>.
[RFC9645] Watsen, K., "YANG Groupings for TLS Clients and TLS
Servers", RFC 9645, DOI 10.17487/RFC9645, October 2024,
<https://www.rfc-editor.org/info/rfc9645>.
[Std-802.1AR-2018]
IEEE, "IEEE Standard for Local and Metropolitan Area
Networks - Secure Device Identity", IEEE Std 802.1AR-2018,
DOI 10.1109/IEEESTD.2018.8423794, August 2018,
<https://standards.ieee.org/standard/802_1AR-2018.html>.
[W3C.REC-xml-20081126]
Bray, T., Paoli, J., Sperberg-McQueen, C. M., Maler, E.,
and F. Yergeau, "Extensible Markup Language (XML) 1.0
(Fifth Edition)", W3C Recommendation REC-xml-20081126,
November 2008, <https://www.w3.org/TR/xml/>.
The authors would like to thank the following for lively discussions on list and in the halls (ordered by first name): Alan Luchuk, Andy Bierman, Balázs Kovács, Benoit Claise, Bert Wijnen, David Lamparter, Eric Voit, Éric Vyncke, Francesca Palombini, Jürgen Schönwälder, Ladislav Lhotka, Liang Xia, Magnus Nyström, Mahesh Jethanandani, Martin Björklund, Mehmet Ersue, Murray Kucherawy, Paul Wouters, Phil Shafer, Qin Wu, Radek Krejci, Ramkumar Dhanapal, Reese Enghardt, Reshad Rahman, Rob Wilton, Roman Danyliw, Sandra Murphy, Sean Turner, Tom Petch, Warren Kumari, and Zaheduzzaman Sarker.
著者は、リストとホールでの活発な議論（名で命じられた）で以下に感謝したいと思います：アラン・ルチュク、アンディ・ビアマン、バラズ・コバカス、ブノワ・クレイズ、バート・ウィジネン、デビッド・ランパーター、エリック・ヴォイト、エリック・ヴィンチケ、フランチェカ・ペアンビニ、ユルゲン・シェーンウェルダー、ラディスラフ・ロッカ、リャン・シア、マグナス・ニシュロム、マヘシュ・ジェタナンダニ、マーティン・ビョルクルンド、メフメット・エルエ、マレー・クチェラウィー、ポール・ウーターズ、フィル・シェーファー、キン・ウー、ラデク・クレジチ、ラム・ラム・ラム・ラスマンローマダニリウ、サンドラ・マーフィー、ショーン・ターナー、トム・ペッチ、ウォーレン・クマリ、ザヘダザマン・サルカー。
Kent Watsen
Watsen Networks
Email: kent+ietf@watsen.net