1. RFC 7589(Using the NETCONF Protocol over Transport Layer Security (TLS) with Mutual X.509
Authentication)ベースの勉強資料です。
下線、ハイライトは個人的に重要そうなところ。斜体、#はメモ。
原文のMUST/REQUIRED/SHALL/SHOULD/MAY/OPTIONAL等のRFC2119用語は原文のまま残しています。
MUST、REQUIRED、SHALL:絶対的な要求事項
MUST NOT:絶対的な禁止事項
SHOULD、RECOMMENDED:慎重に重要性を判断するべき要求事項
SHOULD NOT、NOT RECOMMENDED:慎重に重要性を判断するべき禁止事項
MAY、OPTIONAL:オプション。
間違っていたらコメントをお願いします。
元ネタ(RFC7589)
https://tools.ietf.org/html/rfc7589
Errata
https://www.rfc-editor.org/errata_search.php?rfc=7589
Using the NETCONF Protocol over Transport Layer Security (TLS)
with Mutual X.509 Authentication
Abstract
The Network Configuration Protocol (NETCONF) provides mechanisms to install, manipulate, and
delete the configuration of network devices. This document describes how to use the Transport
Layer Security (TLS) protocol with mutual X.509 authentication to secure the exchange of
NETCONF messages. This revision of RFC 5539 documents the new message framing used by NETCONF
1.1 and it obsoletes RFC 5539.
NETCONFはネットワークデバイスの構成を設定、操作、削除するメカニズムを提供する。相互X.509認証でTLSを使用して
NETCONFメッセージ交換ほ保護する方法について説明する。RFC 5539を廃止する。
Table of Contents
Abstract 1
Table of Contents 1
1. Introduction 3
2. Connection Initiation 3
3. Message Framing 3
4. Connection Closure 4
5. Certificate Validation 4
6. Server Identity 4
7. Client Identity 4
8. Cipher Suites 7
9. Security Considerations 7
10. IANA Considerations 8
1
3. 1. Introduction
The NETCONF protocol [RFC6241] defines a mechanism through which a network device can be
managed. NETCONF is connection-oriented, requiring a persistent connection between peers.
This connection must provide integrity, confidentiality, peer authentication, and reliable,
sequenced data delivery.
NETCONFはネットワークデバイスを管理するメカニズムを提供する。NETCONFはコネクション指向であり、ピア間の永続的なコ
ネクションを必要とする。このコネクションは、インテグリティ、機密性、認証、信頼性、順序性のデータ配信を提供する必要が
ある。
This document defines how NETCONF messages can be exchanged over Transport Layer Security
(TLS) [RFC5246]. Implementations MUST support mutual TLS certificate-based authentication
[RFC5246]. This assures the NETCONF server of the identity of the principal who wishes to
manipulate the management information. It also assures the NETCONF client of the identity of
the server for which it wishes to manipulate the management information.
NETCONFメッセージをTLSを介して交換する方法を定義する。実装は相互TLS証明書ベースの認証をサポートすること。これによ
り、NETCONFサーバー、クライアントの相互のidentityを保証する。
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT",
"RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in
[RFC2119].
キーワード"MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT",
"RECOMMENDED", "MAY", and "OPTIONAL"はRFC 2119の通り解釈される。
2. Connection Initiation
The peer acting as the NETCONF client MUST act as the TLS client. The TLS client actively
opens the TLS connection and the TLS server passively listens for the incoming TLS
connections. The well-known TCP port number 6513 is used by NETCONF servers to listen for TCP
connections established by NETCONF over TLS clients. The TLS client MUST send the TLS
ClientHello message to begin the TLS handshake. The TLS server MUST send a CertificateRequest
in order to request a certificate from the TLS client. Once the TLS handshake has finished,
the client and the server MAY begin to exchange NETCONF messages. Client and server identity
verification is done before the NETCONF <hello> message is sent. This means that the identity
verification is completed before the NETCONF session is started.
NETCONFクライアントとして機能するピアは、TLSクライアントとしてっ機能すること。TLSクライアントは、TLS接続をオープ
ンし、TLSサーバーはTLS接続をTCPポート6513でリッスンする。TLSクライアントは、TLSハンドシェイクを開始するために、
TLS ClinetHelloメッセージを送信すること。TLSサーバーは証明書を要求するためにCertificateRequestを送信するこ
と。クライアントとサーバーのID検証は、NETCONF <hello>メッセージの送信前に行われる。これはNETCONFセッションが開
始される前にID検証が完了することを意味する。
#NETCONF over SSHと同じ認証後にNETCONF開始
3. Message Framing
All NETCONF messages MUST be sent as TLS "application data". It is possible for multiple
NETCONF messages to be contained in one TLS record, or for a NETCONF message to be transferred
in multiple TLS records.
全てのNETCONFメッセージは、TLSアプリケーションデータとして送信されること。複数のNETCONFメッセージが1つのTLSレ
コードに含まれている場合や、NETCONFメッセージが複数のTLSレコードで転送される場合がある。
#Record LayerのContentType = application_data
3
4. The previous version of this specification [RFC5539] used the framing sequence defined in
[RFC4742]. This version aligns with [RFC6242] and adopts the framing protocol defined in
[RFC6242] as follows:
以前のバージョンでは、RFC 4724のフレーミングシーケンスを使用していた。本バージョンでは、RFC 6242のフレーミングプ
ロトコルを以下のように採用する。
The NETCONF <hello> message MUST be followed by the character sequence ]]>]]>. Upon reception
of the <hello> message, the peers inspect the announced capabilities. If the :base:1.1
capability is advertised by both peers, the chunked framing mechanism defined in Section 4.2
of [RFC6242] is used for the remainder of the NETCONF session. Otherwise, the old
end-of-message-based mechanism (see Section 4.3 of [RFC6242]) is used.
NETCONF <hello>メッセージの後には ]]>]]> が続くこと。<hello>メッセージを受信するトピアはアナウンスされた
capabilityを検証する。 :base:1.1 capabilityが両方のピアにアドバタイズされる場合、RFC 6242のchunked
framing mechanismが、アドバタイズされない場合、end-of-message-based mechanismが使用される。
#前者は n で改行、後者は ]]>]]> でメッセージを区切る。
4. Connection Closure
A NETCONF server will process NETCONF messages from the NETCONF client in the order in which
they are received. A NETCONF session is closed using the <close-session> operation. When the
NETCONF server processes a <close-session> operation, the NETCONF server SHALL respond and
close the TLS session as described in Section 7.2.1 of [RFC5246].
NETCONFサーバーはNETCONFクライアントからのNETCONFメッセージを受信順に処理する。NETCONFセッションは、
<close-session>でクローズされる。NETCONFサーバーが<close-session>を処理するとき、NETCONFサーバーは応答し、
TLSセッションを閉じることが推奨される(SHALL)。
#応答とTLSのクローズ手順がSHALLなのか。
5. Certificate Validation
Both peers MUST use X.509 certificate path validation [RFC5280] to verify the integrity of the
certificate presented by the peer. The presented X.509 certificate may also be considered
valid if it matches one obtained by another trusted mechanism, such as using a locally
configured certificate fingerprint. If X.509 certificate path validation fails and the
presented X.509 certificate does not match a certificate obtained by a trusted mechanism, the
connection MUST be terminated as defined in [RFC5246].
両方のピアはX.509証明書パス検証を使用して、ピアによって提示された証明書のインテグリティを検証すること(MUST)。提
示されたX.509証明書は、ローカルの証明書のフィンガープリントを使用する等、別の信頼できる検証メカニズムでも有向とみな
してよい。X.509証明書パスの検証が失敗し、提示されたX.509証明書が信頼できるメカニズムによって取得された証明書と一致
しない場合、接続を終了すること(MUST)。
6. Server Identity
The NETCONF client MUST check the identity of the server according to Section 6 of [RFC6125].
NETCONFクライアントは、サーバーのIDをチェックすること(MUST)。
7. Client Identity
The NETCONF server MUST verify the identity of the NETCONF client to ensure that the incoming
request to establish a NETCONF session is legitimate before the NETCONF session is started.
4
5. NETCONFサーバーは、NETCONFセッションが開始される前に、NETCONFセッションを確立するための着信要求が正当であること
を確認するために、NETCONFクライアントのIDを検証すること(MUST)。
The NETCONF protocol [RFC6241] requires that the transport protocol's authentication process
results in an authenticated NETCONF client identity whose permissions are known to the server.
The authenticated identity of a client is commonly referred to as the NETCONF username. The
following algorithm is used by the NETCONF server to derive a NETCONF username from a
certificate. (Note that the algorithm below is the same as the one described in the
SNMP-TLS-TM-MIB MIB module defined in [RFC6353] and in the ietf-x509-cert-to-name YANG module
defined in [RFC7407].)
NETCONFプロトコルでは、トランスポートプロトコルの認証プロセスの結果、サーバーに認証済みのNETCONFクライアントIDが
生成される必要がある。認証済みのクライアントIDは、一般的にNETCONFユーザー名という。NETCONFサーバーは、以下のアル
ゴリズムを使用して、証明書からNETCONFユーザー名を取得する。以下のアルゴリズムは、SNMP-TLS-TM-MIB MIB moduleお
よび、ietf-x509-cert-to-name YANG moduleのアルゴリズムと同じである。
(a) The server maintains an ordered list of mappings of certificates to NETCONF usernames.
Each list entry contains
サーバーは証明書からNETCONFユーザー名へのマッピングへの順序付きリストをメンテする。各リストには以下が含まれる。
* a certificate fingerprint (used for matching the presented certificate),
証明書のフィンガープリント(提示された証明書の照合に使用)
* a map type (indicates how the NETCONF username is derived from the certificate), and
マップタイプ(NETCONFユーザー名が証明書からどのように導出されるか示す)
* optional auxiliary data (used to carry a NETCONF username if the map type indicates
the username is explicitly configured).
オプションの補助データ(マップタイプが、ユーザー名が明示的に設定されていることを示す場合(例:'specified'
)、NETCONFユーザー名を示すために使用される)
(b) The NETCONF username is derived by considering each list entry in order. The fingerprint
member of the current list entry determines whether the current list entry is a match:
NETCONFユーザー名は各エントリを順番にチェックすることで導出される。現在のエントリのフィンガープリントにより、そのエ
ントリが一致するか確認する。
1. If the list entry's fingerprint value matches the fingerprint of the presented
certificate, then consider the list entry as a successful match.
エントリのフィンガープリントが提示された証明書と一致した場合、そのエントリに一致したとみなす。
2. If the list entry's fingerprint value matches that of a locally held copy of a
trusted certification authority (CA) certificate, and that CA certificate was part of the
CA certificate chain to the presented certificate, then consider the list entry as a
successful match.
エントリのフィンガープリントがCA認証局のフィンガープリントと一致し、そのCA証明書が提示された証明書への証明書
チェーンの一部である場合、エントリは一致したとみなす。
(c) Once a matching list entry has been found, the map type of the current list entry is used
to determine how the username associated with the certificate should be determined. Possible
mapping options are:
一致するエントリが見つかった場合、現在のエントリのマップタイプを使用して証明書に関連付けられているユーザー名特定方法
が決定される。マッピングタイプの種類は以下のとおりである。
A. The username is taken from the auxiliary data of the current list entry. This means
the username is explicitly configured (map type 'specified').
5
6. マップタイプ:'specified'
ユーザー名はエントリの補助データから取得される。これは、ユーザー名が明示的に設定されていることを意味する。
B. The subjectAltName's rfc822Name field is mapped to the username (map type
'san-rfc822-name'). The local part of the rfc822Name is used unaltered, but the
host-part of the name must be converted to lowercase.
マップタイプ:'san-rfc822-name'
subjectAltNameのrfc822Nameフィールドがユーザー名にマップされる。rfc822Nameのローカルパートは変更されず
に使用されるが、ホストパートは小文字に変換すること。
#rfc822NameはASCIIのメールアドレス形式。ローカルパート@ホストパート
C. The subjectAltName's dNSName is mapped to the username (map type 'san-dns-name').
The characters of the dNSName are converted to lowercase.
マップタイプ:'san-dns-name'
subjectAltNameのdNSNameフィールドがユーザー名にマップされる。dNSNameの文字は小文字に変換される。
D. The subjectAltName's iPAddress is mapped to the username (map type 'san-ip-address').
IPv4 addresses are converted into decimal-dotted quad notation (e.g., '192.0.2.1'). IPv6
addresses are converted into a 32-character all lowercase hexadecimal string without any
colon separators.
マップタイプ:'san-ip-address'
subjectAltNameのiPAddressがユーザー名にマップされる。IPv4アドレスは'192.0.2.1'のような10進数のドット
形式に変換される。IPv6アドレスは'20010db8bd0501d2288a1fc0000110ee'コロン区切り無しの32文字の全て小文
字の16進数に変換される。
E. The rfc822Name, dNSName, or iPAddress of the subjectAltName is mapped to the username
(map type 'san-any'). The first matching subjectAltName value found in the certificate
of the above types MUST be used when deriving the name.
マップタイプ:'san-any'
subjectAltNameのrfc822NameまたはdNSNameまたはiPAddressがユーザー名にマップされる。最初の
subjectAltNameがユーザー名を導出するために使用されること(MUST)。
F. The certificate's CommonName is mapped to the username (map type 'common-name'). The
CommonName is converted to UTF-8 encoding. The usage of CommonNames is deprecated and
users are encouraged to use subjectAltName mapping methods instead.
マップタイプ:'common-name'
証明書のCommonNameがユーザー名にマップされる。Common-nameはUTF-8エンコーディングに変換される。
Common-nameの使用は非推奨であり、subjectAltNameマッピングを使用することが推奨される。
(d) If it is impossible to determine a username from the list entry's data combined with the
data presented in the certificate, then additional list entries MUST be searched to look for
another potential match. Similarly, if the username does not comply to the NETCONF
requirements on usernames [RFC6241], then additional list entries MUST be searched to look for
another potential match. If there are no further list entries, the TLS session MUST be
terminated.
証明書で提示されたデータとエントリのデータからユーザー名を特定できなかった場合、残りのリストに対して一致の検索するこ
と(MUST)。同様に、ユーザー名がRFC 6241のNETCONF要件に準拠していない場合は残りのリストに対して一致の検索をする
こと(MUST)。エントリが無い場合は、TLSセッションを終了すること(MUST)。
#ユーザー名要件はW3C.REC-xml-20001006 Section 2.2 CharactersにあるCharである。UTF-8とUTF-16。
The username provided by the NETCONF over TLS implementation will be made available to the
NETCONF message layer as the NETCONF username without modification.
NETCONF over TLSで提供されたユーザー名は、NETCONFメッセージレイヤでNETCONFユーザー名として利用できる。
6
7. The NETCONF server configuration data model [NETCONF-RESTCONF] covers NETCONF over TLS and
provides further details such as certificate fingerprint formats exposed to network
configuration systems.
NETCONFサーバーコンフィグデータモデルは、NETCONF over TLSをカバーし、NETCONFに証明書フィンガープリントフォー
マット等の詳細を提供する。
#https://datatracker.ietf.org/doc/draft-ietf-netconf-netconf-client-server/
8. Cipher Suites
Implementations MUST support TLS 1.2 [RFC5246] and are REQUIRED to support the
mandatory-to-implement cipher suite. Implementations MAY implement additional TLS cipher
suites that provide mutual authentication [RFC5246] and confidentiality as required by NETCONF
[RFC6241]. Implementations SHOULD follow the recommendations given in [RFC7525].
実装は、TLS 1.2をサポートし(MUST)、mandatory-to-implement cipher suiteをサポートすること(MUST)。実装
はRFC 5246 相互認証およびNETCONFで要求されている機密性を提供する追加のTLS暗号スイートをサポートしてもよい(MAY
)。実装はRFC 7525に従うことが推奨される(SHOULD)。
#RFC5246, 9. Mandatory Cipher Suites : https://tools.ietf.org/html/rfc5246#section-9
= TLS_RSA_WITH_AES_128_CBC_SHA
#RFC7525, 4. Recommendations: Cipher Suites : https://tools.ietf.org/html/rfc7525#section-4
9. Security Considerations
NETCONF is used to access configuration and state information and to modify configuration
information, so the ability to access this protocol should be limited to users and systems
that are authorized to view the NETCONF server's configuration and state or to modify the
NETCONF server's configuration.
NETCONFは設定および状態へのアクセスと設定変更に使用されるため、プロトコルへのアクセスにはそれらが許可されているユー
ザーとシステムに制限する必要がある。
Configuration or state data may include sensitive information, such as usernames or security
keys. So, NETCONF requires communications channels that provide strong encryption for data
privacy. This document defines a NETCONF over TLS mapping that provides for support of strong
encryption and authentication. The security considerations for TLS [RFC5246] and NETCONF
[RFC6241] apply here as well.
設定または状態には、ユーザー名やセキュリティキーなどの機密情報が含まれている場合がある。したがって、NETCONFにはデー
タ保護のために強力な暗号化を提供する通信チャネルが必要である。本ドキュメントでは強力な暗号化と認証をサポートする
NETCONF over TLSを定義している。TLSおよびNETCONFのセキュリティ事項も本ドキュメントに適用される。
NETCONF over TLS requires mutual authentication. Neither side should establish a NETCONF over
TLS connection with an unknown, unexpected, or incorrect identity on the opposite side. Note
that the decision whether a certificate presented by the client is accepted can depend on
whether a trusted CA certificate is white listed (see Section 7). If deployments make use of
this option, it is recommended that the white-listed CA certificate is used only to issue
certificates that are used for accessing NETCONF servers. Should the CA certificate be used
to issue certificates for other purposes, then all certificates created for other purposes
will be accepted by a NETCONF server as well, which is likely not suitable.
NETCONF over TLSでは相互認証が必要である。どちら側も対向が不明、予期しない、正しくないIDの場合にNETCONF over
TLSを確立しないこと。クライアントによって提示された証明書を受け入れるかどうかの決定は、信頼できるCA証明書がホワイト
リストにあるかどうかに依存する可能性があることに注意せよ(Section 7参照)。デプロイでこれを使用する場合、ホワイト
リストに記載されたCA証明書は、NETCONFサーバーへのアクセスに使用される証明書の発行にのみ使用されることが推奨され
7
8. る。CA証明書を使用して他の目的で証明書を発行する場合、他の目的で作成した全ての証明書がNETCONFサーバーでも受け入れ
られるため、適切でない可能性がある。
This document does not support third-party authentication (e.g., backend Authentication,
Authorization, and Accounting (AAA) servers) due to the fact that TLS does not specify this
way of authentication and that NETCONF depends on the transport protocol for the
authentication service. If third-party authentication is needed, the Secure Shell (SSH)
transport [RFC6242] can be used.
本ドキュメントでは、TLSが認証方法を規定しておらず、NETCONFが認証をトランスポートプロトコルに依存しているため、サー
ドパーティ認証(バックエンド認証、AAA等)をサポートしていない。サードパーティ認証が必要な場合は、SSHトランスポート
を使用できる。
RFC 5539 assumes that the end-of-message (EOM) sequence, ]]>]]>, cannot appear in any
well-formed XML document, which turned out to be mistaken. The EOM sequence can cause
operational problems and open space for attacks if sent deliberately in NETCONF messages. It
is however believed that the associated threat is not very high. This document still uses the
EOM sequence for the initial <hello> message to avoid incompatibility with existing
implementations. When both peers implement the :base:1.1 capability, a proper framing
protocol (chunked framing mechanism; see Section 3) is used for the rest of the NETCONF
session, to avoid injection attacks.
RFC5539は、メッセージの終わり(EOMシーケンス)、]]>]]> がwell-formed XMLドキュメントに無いことを前提としてい
る。EOMシーケンスは、NETCONFメッセージで意図的に送信された場合、問題を引き起こす可能性がある。本ドキュメントでは、
既存の実装との互換性の欠如を回避するため、最初の<hello>メッセージにEOMシーケンスを引き続き使用している。両方のピア
が :base:1.1 を実装している場合、インジェクション攻撃を回避するために、適切なフレーミングプロトコルが以降の
NETCONFセッションに使用される。
#helloだけはEOMシーケンスあり。
10. IANA Considerations
Service Name netconf-tls
Transport Protocol(s) TCP
Description NETCONF over TLS
Reference RFC 7589
Port Number 6513
Appendix A. Changes from RFC 5539
This section summarizes major changes between this document and RFC 5539.
RFC 5539との主な変更点。
Documented that NETCONF over TLS uses the new message framing if both peers support the
:base:1.1 capability.
両方のピアが:base:1.1 capabilityをサポートしている場合、NETCONF over TLSはメッセージフレーミングを使用す
ることを明確化。
8
9. Removed redundant text that can be found in the TLS and NETCONF specifications and
restructured the text. Alignment with [RFC6125].
TLSおよびNETCONFにある冗長なテキストを削除。
Added a high-level description on how NETCONF usernames are derived from certificates.
証明書からNETCONFユーザー名を導出する方法を追加。
Removed the reference to BEEP.
BEEPへの参照を削除。
9