Internet-Draft | BRSKI-PRM | October 2022 |
Fries, et al. | Expires 27 April 2023 | [Page] |
This document defines enhancements to bootstrapping a remote secure key infrastructure (BRSKI, RFC8995) to facilitate bootstrapping in domains featuring no or only time limited connectivity between a pledge and the domain registrar. It specifically targets situations, in which the interaction model changes from a pledge-initiated-mode, as used in BRSKI, to a pledge-responding-mode as described in this document. To support the pledge-responding mode, BRSKI-PRM introduces a new component, the registrar-agent, which facilitates the communication between pledge and registrar during the bootstrapping phase. To establishment the trust relation between pledge and domain registrar, BRSKI-PRM relies on object security rather than transport security.¶
The approach defined here is agnostic with respect to the underlying enrollment protocol which connects the pledge and the domain registrar to the Domain CA.¶
This note is to be removed before publishing as an RFC.¶
Status information for this document may be found at https://datatracker.ietf.org/doc/draft-ietf-anima-brski-prm/.¶
Source for this draft and an issue tracker can be found at https://github.com/anima-wg/anima-brski-prm.¶
This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.¶
Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at https://datatracker.ietf.org/drafts/current/.¶
Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress."¶
This Internet-Draft will expire on 27 April 2023.¶
Copyright (c) 2022 IETF Trust and the persons identified as the document authors. All rights reserved.¶
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.¶
BRSKI as defined in [RFC8995] specifies a solution for secure zero-touch (automated) bootstrapping of devices (pledges) in a (customer) site domain. This includes the discovery of network elements in the customer site/domain and the exchange of security information necessary to establish trust between a pledge and the domain.¶
Security information about the customer site/domain, specifically the customer site/domain certificate, is exchanged utilizing voucher request objects and voucher response objects as defined in [RFC8995]. Voucher objects are specified in [RFC8366]. Vouchers are signed objects from the Manufacturer's Authorized Signing Authority (MASA). The MASA issues the voucher object and provides it via the domain registrar to the pledge.¶
For the certificate enrollment of devices, BRSKI relies on EST [RFC7030] to request and distribute customer site/domain specific device certificates. EST in turn relies on a binding of the certification request to an underlying TLS connection between the EST client and the EST server.¶
BRSKI addresses scenarios in which the pledge initiates the bootstrapping acting as a client (this document refers to this approach as pledge-initiator-mode). In industrial environments the pledge may behave as a server and thus does not initiate the bootstrapping with the domain registrar. In this scenarios it is expected that the pledge will be triggered to generate bootstrapping requests in the customer site/domain. This document refers to this approach as pledge-responder-mode and¶
The term endpoint used in the context of this document is similar to resources in CoAP [RFC7252] and also in HTTP [RFC9110]. It is not used to describe a device. Endpoints are accessible via .well-known URIs.¶
To utilize the EST server endpoints on the domain registrar, the registrar-agent will act as client towards the domain registrar.¶
The registrar-agent also acts as a client when communicating with a pledge in responder mode. Here, TLS with server-side, certificate-based authentication is not directly applicable, as the pledge only possesses an IDevID certificate. The IDevID does not contain any anchor for which any kind of [RFC6125] validation can be done. Second, the registrar-agent may not be aware of manufacturer trust anchors to validate the IDevIDs. Finally, IDevID do not typically set Extended Key Usage (EKU) for TLS WWW Server authentication.¶
The inability to effectively do TLS in responder mode is one reason for relying on object security. Another reason is the application on different transports channels, for which TLS may not be available, such as Bluetooth and NFC.¶
Therefore, BRSKI-PRM relies on an additional signature wrapping of the exchanged data objects . For EST [RFC7030] the registrar then needs to do some pre-processing to verify this signature, which is not present in EST.¶
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.¶
This document relies on the terminology defined in [RFC8995], section 1.2. The following terms are defined additionally:¶
Describes an object, which is cryptographically bound to the end entity (EE) certificate (IDevID certificate or LDEVID certificate). The binding is assumed to be provided through a digital signature of the actual object using the corresponding private key of the EE certificate.¶
Certification authority, issues certificates.¶
Tool to interact with devices to provide configuration data¶
Certificate Signing Request¶
End entity¶
Mutual authenticated Transport Layer Security.¶
Describes a component or service or functionality available in the customer site/domain.¶
Describes a component or service or functionality not available within the customer site/domain. It may be at a central site or an internet resident "cloud" service. The connection may also be a temporary and, e.g., only available at times when workers are present on a construction side, for instance.¶
Pledge-enrollment-request is a signature wrapped CSR, signed by the pledge that requests enrollment to a domain¶
Proof of possession (of a private key)¶
Pledge-Voucher-Request is a request for a voucher signed by the Pledge to the Registrar.¶
Registration authority, an optional system component to which a CA delegates certificate management functions such as authorization checks.¶
Registrar-enrollment-request is the CSR of PER send to the CA by the registrar (RA/LRA)¶
Registrar-Voucher-Request is a request for a voucher signed by the Registrar to the MASA. It may contain the PVR received from the pledge.¶
This document includes many examples that would contain many long sequences of base64 encoded objects with no content directly comprehensible to a human reader. In order to keep them readable the examples use the token "base64encodedvalue==" whenever such a thing occurs. This token is in fact valid base64. The full examples are in appendix.¶
This protocol unavoidably has a mix of both base64 encoded data (as is normal for many JSON encoded protocols), and also BASE64URL encoded data, as specified by JWS. The later is indicated by a string like "BASE64URL(THING)"¶
BRSKI-PRM is applicable to environments where pledges may have different behavior: pledge-responder-mode, or pledges may have no direct connection to the domain registrar. Either way pledges are expected to be managed by the same registrar.¶
This can be motivated by pledges deployed in environments not yet connected to the operational customer site/domain network, e.g., at a construction site where a building is going up.¶
Another environment relates to the assembly of cabinets, which are prepared in advance to be installed on a customer site/domain.¶
As there is no direct connection to the registrar available in these environments the solution specified allows the pledges to act in a server role so they can be triggered for bootstrapping e.g., by a commissioning tool.¶
As BRSKI focuses on the pledge in a client role, initiating the bootstrapping (pledge-initiated-mode), BRSKI-PRM defines pledges acting as a server (pledge-responder-mode) responding to PVR and PER and consumption of the results.¶
The following examples motivate support of BRSKI-PRM to support pledges acting as server as well as pledges with limited connectivity to the registrar.¶
While BRSKI-PRM defines support for pledges in responder mode, there may be pledges, which can act as both initiator or responder. In these cases BRSKI-PRM can be combined with BRSKI as defined in [RFC8995] or BRSKI-AE [I-D.ietf-anima-brski-ae] to allow for more bootstrapping flexibility.¶
A pledge which can initiate, SHOULD listen for BRSKI messages as describe in [RFC8995], Section 4.1. Upon discovery of a potential Registrar, it SHOULD initiate to that Registrar. At the same time (so as to avoid the Slowloris-attack described in [RFC8995]), it SHOULD also respond to the pledge-responder-mode connections described in this document.¶
Once a pledge with such combined functionality has been bootstrapped, it may act as client for enrollment or re-enrollment of further certificates needed, e.g., using the enrollment protocol of choice. If it still acts as server, the defined endpoints can be used to trigger a Pledge-Enrollment-Request (PER) for further certificates.¶
In building automation a typical use case exists where a detached building (or a cabinet) or the basement of a building is equipped with sensors, actuators and controllers, but with only limited or no connection to the central building management system. This limited connectivity may exist during installation time or also during operation time.¶
During the installation, for instance, in the basement, a service technician collects the device specific information from the basement network and provides them to the central building management system. This could be done using a laptop, common mobile device, or dedicated commissioning tool to transport the information. The service technician may visit every new house in a subdivision collecting device specific information before connecting to the Registrar.¶
A domain registrar may be part of the central building management system and already be operational in the installation network. The central building management system can then provide operational parameters for the specific devices in the basement. This operational parameters may comprise values and settings required in the operational phase of the sensors/actuators, among them a certificate issued by the operator to authenticate against other components and services. These operational parameters are then provided to the devices in the basement facilitated by the service technician's laptop.¶
This refers to any case in which the network infrastructure is normally isolated from the Internet as a matter of policy, most likely for security reasons. In such a case, limited access to a domain registrar may be allowed in carefully controlled short periods of time, for example when a batch of new devices are deployed, but prohibited at other times.¶
The registration authority (RA) performing the authorization of a certificate request is a critical PKI component and therefore requires higher operational security than other components utilizing the issued certificates. CAs may also require higher security in the registration procedures. There may be situations in which the customer site/domain does not offer enough security to operate a RA/CA and therefore this service is transferred to a backend that offers a higher level of operational security.¶
The mechanism described in this document presume the availability of the pledge to communicate with the registrar-agent. This may not be possible in constrained environments where, in particular, power must be conserved. In these situations, it is anticipated that the transceiver will be powered down most of the time. This presents a rendezvous problem: the pledge is unavailable for certain periods of time, and the registrar-agent is similarly presumed to be unavailable for certain periods of time.¶
Based on the intended target environment described in Section 3.1 the following requirements are derived to support bootstrapping of pledges in responder mode (acting as server).¶
At least the following properties are required for the voucher and enrollment processing:¶
Solution examples based on existing technology are provided with the focus on existing IETF RFCs:¶
For BRSKI with pledge in responder mode, the base system architecture defined in BRSKI [RFC8995] is enhanced to facilitate the new use cases in which the pledge acts as server. The pledge-responder-mode allows delegated bootstrapping using a registrar-agent instead of a direct connection between the pledge and the domain registrar.¶
Necessary enhancements to support authenticated self-contained objects for certificate enrollment are kept at a minimum to enable reuse of already defined architecture elements and interactions.¶
For the authenticated self-contained objects used for the certification request, BRSKI-PRM relies on the defined message wrapping mechanisms of the enrollment protocols stated in Section 4 above.¶
The security used within the document for bootstrapping objects produced or consumed by the pledge bases on JOSE [RFC7515]. In constraint environments it may provided based on COSE [RFC9052].¶
An abstract overview of the BRSKI-PRM protocol can be found in [BRSKI-PRM-abstract].¶
To support mutual trust establishment between the domain registrar and pledges not directly connected to the customer site/domain, this document specifies the exchange of authenticated self-contained objects (the voucher request/response as known from BRSKI and the enrollment request/response as introduced by BRSKI-PRM) with the help of a registrar-agent.¶
This leads to extensions of the logical components in the BRSKI architecture as shown in Figure 1. Note that the Join Proxy is neglected in the figure as not needed by the registrar-agent. The registrar-agent interacts with the pledge to transfer the required data objects for bootstrapping, which are then also exchanged between the registrar-agent and the domain registrar. The addition of the registrar-agent influences the sequences of the data exchange between the pledge and the domain registrar as described in [RFC8995]. To enable reuse of BRSKI defined functionality as much as possible, BRSKI-PRM:¶
The following list describes the components in a (customer) site domain:¶
Pledge: The pledge is expected to respond with the necessary data objects for bootstrapping to the registrar-agent. The protocol used between the pledge and the registrar-agent is assumed to be HTTP in the context of this document. Other protocols may be used like CoAP, Bluetooth, or NFC, but are out of scope of this document. A pledge acting as a server during bootstrapping leads to some differences to BRSKI:¶
"Agent-proximity" is a statement, that the proximity registrar certificate was provided via the registrar-agent as defined in Section 6 and not directly to the pledge. "Agent-proximity" is therefore a weaker assertion then "proximity". It is defined as additional assertion type in [I-D.ietf-anima-rfc8366bis]. This can be verified by the registrar and also by the MASA during the voucher-request processing. Note that at the time of creating the voucher-request, the pledge cannot verify the registrar's registrar EE certificate and has no proof-of-possession of the corresponding private key for the certificate. The pledge therefore accepts the registrar EE certificate provisionally until it receives the voucher as described in Section 6.3. See also [RFC8995] "PROVISIONAL accept of server cert".¶
Trust handover to the domain is established via the "pinned-domain-certificate" in the voucher.¶
In contrast to the above, "proximity" provides a statement, that the pledge was in direct contact with the registrar and was able to verify proof-of-possession of the private key in the context of the TLS handshake. The provisionally accepted registrar EE certificate can be verified after the voucher has been processed by the pledge. As the returned voucher includes an additional signature by the registrar as defined in Section 6.2.5, the pledge can also verify that the registrar possesses the corresponding private key.¶
The pledge is triggered by the registrar-agent to generate the PVR and PER as well as for the processing of the responses and the generation of status information. Due to the use of the registrar-agent, the interaction with the domain registrar is changed as shown in Figure 3. To enable interaction with the registrar-agent, the pledge provides endpoints using the BRSKI defined endpoints based on the "/.well-known/brski" URI tree.¶
The following endpoints are defined for the pledge in this document. The URI path begins with "http://www.example.com/.well-known/brski" followed by a path-suffix that indicates the intended operation.¶
Operations and their corresponding URIs:¶
Operation | Operation path | Details |
---|---|---|
Trigger pledge-voucher-request creation - Returns PVR | /pledge-voucher-request | Section 6.1 |
Trigger pledge-enrollment-request - Returns PER | /pledge-enrollment-request | Section 6.1 |
Provide voucher to pledge - Returns pledge-voucher-status | /pledge-voucher | Section 6.3 |
Provide enrollment response to pledge - Returns pledge-enrollment-status | /pledge-enrollment | Section 6.3 |
Provide CA certs to pledge | /pledge-CACerts | Section 6.3 |
Query bootstrapping status of pledge - Returns pledge-status | /pledge-bootstrap-status | Section 6.4 |
The registrar-agent as a new component provides connectivity between the pledge and the domain registrar and reuses the endpoints of the domain registrar side already specified in [RFC8995]. It facilitates the exchange of data between the pledge and the domain registrar, which are the voucher request/response, the enrollment request/response, as well as related telemetry and status information. For the communication with the pledge the registrar-agent utilizes communication endpoints provided by the pledge. The transport in this specification is based on HTTP but may also be done using other transport mechanisms. This new component changes the general interaction between the pledge and the domain registrar as shown in Figure 1.¶
For authentication to the domain registrar, the registrar-agent uses its LDevID(RegAgt). The provisioning of the registrar-agent LDevID is out of scope for this document, but may be done in advance using a separate BRSKI run or by other means like configuration. It is recommended to use short lived registrar-agent LDevIDs in the range of days or weeks as outlined in Section 10.3.¶
The registrar-agent will use its LDevID(RegAgt) when establishing a TLS session with the domain registrar for TLS client authentication. The LDevID(RegAgt) certificate MUST include a SubjectKeyIdentifier (SKID), which is used as reference in the context of an agent-signed-data object as defined in Section 6.1. Note that this is an additional requirement for issuing the certificate, as [IEEE-802.1AR] only requires the SKID to be included for intermediate CA certificates. [RFC8995] makes a similar requirement. In BRSKI-PRM, the SKID is used in favor of a certificate fingerprint to avoid additional computations.¶
Using an LDevID for TLS client authentication of the registrar-agent is a deviation from [RFC8995], in which the pledge's IDevID credential is used to perform TLS client authentication. The use of the LDevID(RegAgt) allows the domain registrar to distinguish, if bootstrapping is initiated from a pledge or from a registrar-agent and to adopt different internal handling accordingly. If a registrar detects a request that originates from a registrar-agent it is able to switch the operational mode from BRSKI to BRSKI-PRM. This may be supported by a specific naming in the SAN (subject alternative name) component of the LDevID(RegAgt) certificate. Alternatively, the domain may feature a CA specifically for issuing registrar-agent LDevID certificates. This allows the registrar to detect registrar-agents based on the issuing CA.¶
As BRSKI-PRM uses authenticated self-contained data objects between the pledge and the domain registrar, the binding of the pledge identity to the requests is provided by the data object signature employing the pledge's IDevID. The objects exchanged between the pledge and the domain registrar used in the context of this specifications are JOSE objects.¶
In addition to the LDevID(RegAgt), the registrar-agent is provided with the product-serial-number(s) of the pledge(s) to be bootstrapped. This is necessary to allow the discovery of pledge(s) by the registrar-agent using mDNS (see Section 5.4.2) The list may be provided by administrative means or the registrar agent may get the information via an interaction with the pledge. For instance, [RFC9238] describes scanning of a QR code, the product-serial-number would be initialized from the 12N B005 Product Serial Number.¶
According to [RFC8995] section 5.3, the domain registrar performs the pledge authorization for bootstrapping within his domain based on the pledge voucher-request object.¶
The following information MUST be available at the registrar-agent:¶
The discovery of the domain registrar may be done as specified in [RFC8995] with the deviation that it is done between the registrar-agent and the domain registrar. Alternatively, the registrar-agent may be configured with the address of the domain registrar and the certificate of the domain registrar.¶
The discovery of the pledge by registrar-agent should be done by using DNS-based Service Discovery [RFC6763] over Multicast DNS [RFC6762] to discover the pledge. The pledge constructs a local host name based on device local information (product-serial-number), which results in "product-serial-number._brski-pledge._tcp.local".¶
The registrar-agent MAY use¶
A manufacturer may allow the pledge to react on mDNS discovery without his product-serial-number contained. This allows a commissioning tool to discover pledges to be bootstrapped in the domain. The manufacturer may opt out of this functionality as outlined in Section 10.4.¶
To be able to detect the pledge using mDNS, network connectivity is required. For Ethernet it is provided by simply connecting the network cable. For WiFi networks, connectivity can be provided by using a pre-agreed SSID for bootstrapping. The same approach can be used by 6LoWPAN/mesh using a pre-agreed PAN ID. How to gain network connectivity is out of scope of this document.¶
The interaction of the pledge with the registrar-agent may be accomplished using different transport means (protocols and/or network technologies). This specification descibes the usage of HTTP as in BRSKI [RFC8995]. Alternative transport channels may be CoAP, Bluetooth Low Energy (BLE), or Nearfield Communication (NFC). These transport means may differ from, and are independent of, the ones used between the registrar-agent and the registrar. Transport channel independence is realized by data objects which are not bound to specific transport security. Therefore, authenticated self-contained objects (here: signature-wrapped objects) are applied for data exchanges between the pledge and the registrar.¶
The registrar-agent provides the domain registrar certificate (registrar EE certificate) to the pledge to be included in the PVR leaf "agent-provided-proximity-registrar-certificate". This enables the registrar to verify that it is the desired registrar for handling the request.¶
The registrar certificate may be configured at the registrar-agent or may be fetched by the registrar-agent based on a prior TLS connection with this domain registrar. In addition, the registrar-agent provides agent-signed-data containing the pledge product-serial-number, signed with the LDevID(RegAgt). This enables the registrar to verify and log, which registrar-agent was in contact with the pledge, when verifying the PVR.¶
The registrar MUST fetch the LDevID(RegAgt) certificate based on the SubjectKeyIdentifier (SKID) in the header of the agent-signed-data from the PVR. The registrar includes the LDevID(RegAgt) certificate information into the RVR if the PVR asked for the assertion "agent-proximity".¶
The MASA in turn verifies the registrar EE certificate is included in the PVR ("prior-signed-voucher-request" of RVR) in the "agent-provided-proximity-registrar-certificate" leaf and may assert the PVR as "verified" or "logged" instead of "proximity", as there is no direct connection between the pledge and the registrar.¶
In addition, the MASA can state the assertion "agent-proximity" as follows: The MASA can verify the signature of the agent-signed-data contained in the prior-signed-voucher-request, based on the provided LDevID(RegAgt) certificate in the "agent-sign-cert" leaf of the RVR. If both can be verified successfully, the MASA can assert "agent-proximity" in the voucher.¶
Depending on the MASA verification policy, it may also respond with a suitable 4xx or 5xx status code as described in section 5.6 of [RFC8995]. The voucher then can be supplied via the registrar to the registrar-agent.¶
Figure 2 provides an overview of the exchanges detailed in the following sub sections.¶
The following sub sections split the interactions between the different components into:¶
The following description assumes that the registrar-agent has already discovered the pledge. This may be done as described in Section 5.4.2 based on mDNS or similar.¶
The focus is on the exchange of signature-wrapped objects using endpoints defined for the pledge in Section 5.3.¶
Preconditions:¶
Registrar-agent: possesses/trusts IDevID CA certificate and has own LDevID(RegAgt) credentials for the registrar domain (site). In addition, the registrar-agent MUST know the product-serial-number(s) of the pledge(s) to be bootstrapped. The registrar-agent MAY be provided with the product-serial-number(s) in different ways:¶
Note: The registrar-agent may trigger the pledge for the PVR or the PER or both. It is expected that this will be aligned with a service technician workflow, visiting and installing each pledge.¶
Triggering the pledge to create the PVR is done using HTTP POST on the defined pledge endpoint: "/.well-known/brski/pledge-voucher-request"¶
The registrar-agent PVR trigger Content-Type header is: application/json
.
Following parameters are provided in the JSON object:¶
The trigger for the pledge to create a PVR is depicted in the following figure:¶
The pledge provisionally accepts the agent-provided-proximity-registrar-cert, it SHOULD verify it after a voucher is received. The pledge will be unable to verify the agent-signed-data itself as it does not possess the LDevID(RegAgt) certificate and the domain trust has not been established at this point of the communication. It SHOULD be done, after the voucher has been received.¶
The agent-signed-data is a JSON-in-JWS object and contains the following information:¶
The header of the agent-signed-data contains:¶
The body of the agent-signed-data contains an "ietf-voucher-request-prm:agent-signed-data" element (defined in Section 7.1):¶
Upon receiving the voucher-request trigger, the pledge SHALL construct the body of the PVR as defined in [RFC8995]. It will contain additional information provided by the registrar-agent as specified in the following. This PVR becomes a JSON-in-JWS object as defined in [I-D.ietf-anima-jws-voucher]. If the pledge is unable to construct the PVR it SHOULD respond with a HTTP error code to the registrar-agent to indicate that it is not able to create the PVR.¶
The following client error responses MAY be used:¶
application/json
.¶
The header of the PVR SHALL contain the following parameters as defined in [RFC7515]:¶
The payload of the PVR MUST contain the following parameters as part of the ietf-voucher-request-prm:voucher as defined in [RFC8995]:¶
The ietf-voucher-request:voucher is enhanced with additional parameters:¶
The enhancements of the YANG module for the ietf-voucher-request with these new leaves are defined in Section 7.1.¶
The PVR is signed using the pledge's IDevID credential contained as x5c parameter of the JOSE header.¶
The PVR Content-Type is defined in [I-D.ietf-anima-jws-voucher] as application/voucher-jws+json
.¶
The pledge SHOULD include this Content-Type header field indicating the included media type for the PVR. Note that this is also an indication regarding the acceptable format of the voucher response. This format is included by the registrar as described in Section 6.2.¶
Once the registrar-agent has received the PVR it can trigger the pledge to generate a PER. As in BRSKI the PER contains a PKCS#10, but additionally signed using the pledge's IDevID. Note, as the initial enrollment aims to request a generic certificate, no certificate attributes are provided to the pledge.¶
Triggering the pledge to create the enrollment-request is done using HTTP POST on the defined pledge endpoint: "/.well-known/brski/pledge-enrollment-request"¶
The registrar-agent PER trigger Content-Type header is: application/json
with an empty body by default.
Note that using HTTP POST allows for an empty body, but also to provide additional data, like CSR attributes or information about the enroll type "enroll-generic-cert" or "re-enroll-generic-cert".
The "enroll-generic-cert" case is shown in Figure 7.¶
In the following the enrollment is described as initial enrollment with an empty HTTP POST body.¶
Upon receiving the enrollment-trigger, the pledge SHALL construct the PER as authenticated self-contained object. The CSR already assures proof of possession of the private key corresponding to the contained public key. In addition, based on the additional signature using the IDevID, proof of identity is provided. Here, a JOSE object is being created in which the body utilizes the YANG module ietf-ztp-types with the grouping for csr-grouping for the CSR as defined in [I-D.ietf-netconf-sztp-csr].¶
Depending on the capability of the pledge, it constructs the enrollment request (PER) as plain PKCS#10. Note, the focus in this use case is placed on PKCS#10 as PKCS#10 can be transmitted in different enrollment protocols in the infrastructure like EST, CMP, CMS, and SCEP. If the pledge has already implemented an enrollment protocol, it may leverage that functionality for the creation of the CSR. Note, [I-D.ietf-netconf-sztp-csr] also allows for inclusion of certification requests in different formats used by CMP or CMC.¶
The pledge SHOULD construct the PER as PKCS#10. In BRSKI-PRM it MUST sign it additionally with its IDevID credentials to provide proof-of-identity bound to the PKCS#10 as described below.¶
If the pledge is unable to construct the PER it SHOULD respond with a HTTP 4xx/5xx error code to the registrar-agent to indicate that it is not able to create the PER.¶
The following 4xx client error codes MAY be used:¶
application/json
.¶
application/jose+json
.¶
A successful enrollment will result in a generic LDevID certificate for the pledge in the new domain, which can be used to request further (application specific) LDevID certificates if necessary for operation. The registrar-agent SHALL use the endpoints specified in this document.¶
[I-D.ietf-netconf-sztp-csr] considers PKCS#10 but also CMP and CMC as certification request format. Note that the wrapping signature is only necessary for plain PKCS#10 as other request formats like CMP and CMS support the signature wrapping as part of their own certificate request format.¶
The registrar-agent enrollment-request Content-Type header for a signature-wrapped PKCS#10 is: application/jose+json
¶
The header of the pledge enrollment-request SHALL contain the following parameter as defined in [RFC7515]:¶
The body of the pledge enrollment-request SHOULD contain a P10 parameter (for PKCS#10) as defined for ietf-ztp-types:p10-csr in [I-D.ietf-netconf-sztp-csr]:¶
The JOSE object is signed using the pledge's IDevID credential, which corresponds to the certificate signaled in the JOSE header.¶
With the collected PVR and PER, the registrar-agent starts the interaction with the domain registrar.¶
The new protected header field "created-on" is introduced to reflect freshness of the PER. The field is marked critical "crit" to ensure that it must be understood and validated by the receiver (here the domain registrar) according to section 4.1.11 of [RFC7515]. It allows the registrar to verify the timely correlation between the PER and previously exchanged messages, i.e., created-on of PER >= created-on of PVR >= created-on of PVR trigger.¶
As the registrar-agent is intended to facilitate communication between the pledge and the domain registrar, a collection of requests from more than one pledge is possible. This allows bulk bootstrapping of several pledges using the same connection between the registrar-agent and the domain registrar.¶
The BRSKI-PRM bootstrapping exchanges between registrar-agent and domain registrar resemble the BRSKI exchanges between pledge and domain registrar (pledge-initiator-mode) with some deviations.¶
Preconditions:¶
The registrar-agent establishes a TLS connection to the registrar. As already stated in [RFC8995], the use of TLS 1.3 (or newer) is encouraged. TLS 1.2 or newer is REQUIRED on the registrar-agent side. TLS 1.3 (or newer) SHOULD be available on the registrar, but TLS 1.2 MAY be used. TLS 1.3 (or newer) SHOULD be available on the MASA, but TLS 1.2 MAY be used.¶
In contrast to BRSKI [RFC8995] TLS client authentication to the registrar is achieved by using registrar-agent LDevID(RegAgt) credentials instead of pledge IDevID credentials. Consequently BRSKI (pledge-initiator-mode) is distinguishable from BRSKI-PRM (pledge-responder-mode) by the registrar. The registrar SHOULD verify that the registrar-agent is authorized to establish a connection to the registrar by TLS client authentication using LDevID(RegAgt) credentials. If the connection from registrar-agent to registrar is established, the authorization SHALL be verified again based on agent-signed-data contained in the PVR. This ensures that the pledge has been triggered by an authorized registrar-agent.¶
The registrar can receive request objects in different formats as defined in [RFC8995]. Specifically, the registrar will receive JSON-in-JWS objects generated by the pledge for voucher-request and enrollment-request (instead of BRSKI voucher-request as CMS-signed JSON and enrollment-request as PKCS#10).¶
The registrar-agent SHALL send the PVR by HTTP POST to the registrar endpoint: "/.well-known/brski/requestvoucher"¶
The Content-Type header field for JSON-in-JWS PVR is: application/voucher-jws+json
(see Figure 6 for the content definition), as defined in [I-D.ietf-anima-jws-voucher].¶
The registrar-agent SHOULD set the Accept field in the request-header indicating the acceptable Content-Type for the voucher-response.
The voucher-response Content-Type header field SHOULD be set to application/voucher-jws+json
as defined in [I-D.ietf-anima-jws-voucher].¶
After receiving the PVR from registrar-agent, the registrar SHALL perform the verification as defined in section 5.3 of [RFC8995]. In addition, the registrar SHALL verify the following parameters from the PVR:¶
If the validation fails the registrar SHOULD respond with HTTP 404 Not Found status code to the registrar-agent. HTTP 406 Not Acceptable status code SHOULD be used if the Content-Type indicated by the Accept header is unknown or unsupported.¶
If the validation succeeds, the registrar SHOULD accept the PVR to join the domain as defined in section 5.3 of [RFC8995]. The registrar then establishes a TLS connection to MASA as described in section 5.4 of [RFC8995] to obtain a voucher for the pledge.¶
The registrar SHALL construct the payload of the RVR as defined in [RFC8995]. The RVR encoding SHALL be JSON-in-JWS as defined in [I-D.ietf-anima-jws-voucher].¶
The header of the RVR SHALL contain the following parameter as defined for JWS [RFC7515]:¶
The payload of the RVR MUST contain the following parameter as part of the voucher-request as defined in [RFC8995]:¶
The RVR MUST be enhanced with the following parameter, when the assertion "agent-proximity" is requested, as defined in Section 7.1:¶
If only a single object is contained in the x5c it MUST be the base64-encoded LDevID(RegAgt) certificate. If multiple certificates are included in the x5c, the first MUST be the base64-encoded LDevID(RegAgt) certificate.¶
The MASA uses this information for verification that the registrar-agent is in proximity to the registrar to state the corresponding assertion "agent-proximity".¶
The object is signed using the registrar EE credentials, which corresponds to the certificate referenced in the JOSE header.¶
The registrar SHALL send the RVR to the MASA endpoint by HTTP POST: "/.well-known/brski/requestvoucher"¶
The RVR Content-Type header field is defined in [I-D.ietf-anima-jws-voucher] as: application/voucher-jws+json
¶
The registrar SHOULD set the Accept header of the RVR indicating the desired media type for the voucher-response.
The media type is application/voucher-jws+json
as defined in [I-D.ietf-anima-jws-voucher].¶
Once the MASA receives the RVR it SHALL perform the verification as described in section 5.5 in [RFC8995].¶
In addition, the following processing SHALL be performed for PVR contained in RVR "prior-signed-voucher-request" field:¶
If validation fails, the MASA SHOULD respond with an HTTP 4xx client error status code to the registrar. The HTTP error status codes are kept the same as defined in section 5.6 of [RFC8995] and comprise the codes: 403, 404, 406, and 415.¶
The expected voucher-response format for BRSKI-PRM (pledge-responder-mode) application/voucher-jws+json
as defined in [I-D.ietf-anima-jws-voucher] SHOULD be applied.
If the MASA detects that the Accept header of the PVR does not match the application/voucher-jws+json
it SHOULD respond with the HTTP status code 406 Not Acceptable as the pledge will not be able to parse the response.
The voucher syntax is described in detail by [RFC8366]. Figure 11 shows an example of the contents of a voucher.¶
The MASA returns the voucher-response (voucher) to the registrar.¶
After receiving the voucher the registrar SHOULD evaluate it for transparency and logging purposes as outlined in section 5.6 of [RFC8995]. The registrar MUST add an additional signature to the MASA provided voucher using its registrar credentials. The signature is created by signing the original "JWS Payload" produced by MASA and the registrar added "JWS Protected Header" using the registrar EE credentials (see[RFC7515], section 5.2 point 8. The x5c component of the "JWS Protected Header" MUST contain registrar EE certificate as well as potential intermediate CA certificates up to the pinned domain certificate. The pinned domain certificate is already contained in the voucher payload ("pinned-domain-cert").¶
This signature provides a proof of possession of the private key corresponding to the registrar EE certificate the pledge received in the trigger for the PVR (see Figure 4). The registrar MUST use the same registrar EE credentials used for authentication in the TLS handshake to authenticate towards the registrar-agent. This ensures that the same registrar EE certificate can be used to verify the signature as transmitted in the voucher request as also transferred in the PVR in the "agent-provided-proximity-registrar-cert". Figure 12 below provides an example of the voucher with two signatures.¶
Depending on the security policy of the operator, this signature can also be interpreted by the pledge as explicit authorization of the registrar to install the contained trust anchor. The registrar sends the voucher to the registrar-agent.¶
After receiving the voucher, the registrar-agent sends the PER to the registrar. Deviating from BRSKI the PER is not a raw PKCS#10. As the registrar-agent is involved in the exchange, the PKCS#10 is wrapped in a JWS object by the pledge and signed with pledge's IDevID to ensure proof-of-identity as outlined in Figure 8.¶
EST [RFC7030] standard endpoints (/simpleenroll, /simplereenroll, /serverkeygen, /cacerts) on the registrar cannot be used for BRSKI-PRM. This is caused by the utilization of signature wrapped-objects in BRSKI-PRM. As EST requires to sent a raw PKCS#10 request to e.g., "/.well-known/est/simpleenroll" endpoint, this document makes an enhancement by utilizing EST but with the exception to transport a signature wrapped PKCS#10 request. Therefore a new endpoint for BRSKI-PRM on the registrar is defined as "/.well-known/brski/requestenroll"¶
The Content-Type header of PER is: application/jose+json
.¶
This is a deviation from the Content-Type header values used in [RFC7030] and results in additional processing at the domain registrar (as EST server). Note, the registrar is already aware that the bootstrapping is performed in a pledge-responder-mode due to the use of the LDevID(RegAgt) certificate for TLS and the provided PVR as JSON-in-JWS object.¶
application/jose+json
, it MUST verify the wrapping signature using the certificate indicated in the JOSE header.¶
The registrar-agent SHALL send the PER to the registrar by HTTP POST to the endpoint: "/.well-known/brski/requestenroll"¶
The registrar SHOULD respond with an HTTP 200 OK in the success case or fail with HTTP 4xx/5xx status codes as defined by the HTTP standard.¶
A successful interaction with the domain CA will result in a pledge LDevID certificate, which is then forwarded by the registrar to the registrar-agent using the Content-Type header: application/pkcs7-mime
.¶
As the pledge will verify it own certificate LDevID certificate when received, it also needs the corresponding CA certificates. This is done in EST [RFC7030] using the "/.well-known/est/cacerts" endpoint, which provides the CA certificates over a TLS protected connection. BRSKI-PRM requires a signature wrapped CA certificate object, to avoid that the pledge can be provided with arbitrary CA certificates in an authorized way. The registrar signed CA certificate object will allow the pledge to verify the authorization to install the received CA certificate(s). As the CA certificate(s) are provided to the pledge after the voucher, the pledge has the required information (the domain certificate) to verify the wrapped CA certificate object.¶
To support registrar-agents requesting a signature wrapped CA certificate(s) object, a new endpoint for BRSKI-PRM is defined on the registrar: "/.well-known/brski/wrappedcacerts"¶
The registrar-agent SHALL requests the EST CA trust anchor database information (in form of CA certificates) by HTTP GET.¶
The Content-Type header of the response SHALL be: application/jose+json
.¶
This is a deviation from the Content-Type header values used in EST [RFC7030] and results in additional processing at the domain registrar (as EST server). The additional processing is to sign the CA certificate(s) information using the registrar EE credentials. This results in a signed CA certificate(s) object (JSON-in-JWS), the CA certificates are provided as base64 encoded "x5b" in the JWS payload.¶
It is assumed that the registrar-agent already obtained the bootstrapping response objects from the domain registrar and can supply them to the pledge: * voucher-response - Voucher (from MASA via Registrar) * wrapped-CA-certificate(s)-response - CA certificates * enrollment-response - LDevID(Pledge) certificate (from CA via Registrar)¶
The registrar-agent will re-connect to the pledge. To contact the pledge, it may either discover the pledge as described in Section 5.4.2 or use stored information from the first contact with the pledge.¶
Preconditions in addition to Section 6.2:¶
The registrar-agent provides the information via distinct pledge endpoints as following.¶
The registrar-agent SHALL send the voucher-response to the pledge by HTTP POST to the endpoint: "/.well-known/brski/pledge-voucher".¶
The registrar-agent voucher-response Content-Type header is application/voucher-jws+json
and contains the voucher as provided by the MASA. An example if given in Figure 11 for a MASA signed voucher and in Figure 12 for the voucher with the additional signature of the registrar.¶
A nonceless voucher may be accepted as in [RFC8995] and may be allowed by a manufactures pledge implementation.¶
To perform the validation of multiple signatures on the voucher object, the pledge SHALL perform the signature verification in the following order:¶
If all steps stated above have been performed successfully, the pledge SHALL terminate the "PROVISIONAL accept" state for the domain trust anchor and the registrar EE certificate.¶
If an error occurs during the verification and validation of the voucher, this SHALL be reported in the reason field of the pledge voucher status.¶
After voucher verification and validation the pledge MUST reply with a status telemetry message as defined in section 5.7 of [RFC8995]. The pledge generates the voucher-status and provides it as signed JSON-in-JWS object in response to the registrar-agent.¶
The response has the Content-Type application/jose+json
and is signed using the IDevID of the pledge as shown in Figure 15.
As the reason field is optional (see [RFC8995]), it MAY be omitted in case of success.¶
The registrar-agent SHALL provide the set of CA certificates requested from the registrar to the pledge by HTTP POST to the endpoint: "/.well-known/brski/pledge-CAcerts".¶
As the CA certificate provisioning is crucial from a security perspective, this provisioning SHALL only be done, if the voucher-response has been successfully processed by pledge.¶
The supply CA certificates message has the Content-Type application/jose+json
and is signed using the credential of the registrar pledge as shown in Figure 13.¶
The CA certificates are provided as base64 encoded "x5b". The pledge SHALL install the received CA certificates as trust anchor after successful verification of the registrar's signature.¶
If validation of the wrapping signature or another security check fails, the pledge SHOULD respond with the HTTP 403 Forbidden status code. The HTTP 415 Unsupported Media Type status code SHOULD be used, if the Content-Type of the request is in an unknown or unsupported format. The HTTP 400 Bad Request status code SHOULD be used, if the pledge detects errors in the encoding of the payload.¶
The registrar-agent SHALL send the enroll-response to the pledge by HTTP POST to the endpoint: "/.well-known/brski/pledge-enrollment".¶
The registrar-agent enroll-response Content-Type header, when using EST [RFC7030] as enrollment protocol between the registrar-agent and the infrastructure is: application/pkcs7-mime
.
Note: It only contains the LDevID certificate for the pledge, not the certificate chain.¶
Upon reception, the pledge SHALL verify the received LDevID certificate. The pledge SHALL generate the enroll status and provide it in the response to the registrar-agent. If the verification of the LDevID certificate succeeds, the status SHALL be set to true, otherwise to FALSE.¶
The pledge MUST reply with a status telemetry message as defined in section 5.9.4 of [RFC8995]. As for the other objects, the enroll-status is signed and results in a JSON-in-JWS object. If the pledge verified the received LDevID certificate successfully it SHALL sign the response using its new LDevID credentials as shown in Figure 16. In the failure case, the pledge SHALL use the available IDevID credentials. As the reason field is optional, it MAY be omitted in case of success.¶
The response has the Content-Type application/jose+json
.¶
Once the registrar-agent has collected the information, it can connect to the registrar-agent to provide the status responses to the registrar.¶
The following description requires that the registrar-agent has collected the status information from the pledge. It SHALL provide the status information to the registrar for further processing.¶
Preconditions in addition to Section 6.2:¶
The registrar-agent MUST provide the collected pledge voucher status to the registrar. This status indicates if the pledge could process the voucher successfully or not.¶
If the TLS connection to the registrar was closed, the registrar-agent establishes a TLS connection with the registrar as stated in Section 6.2.¶
The registrar-agent sends the pledge voucher status without modification to the registrar with an HTTP-over-TLS POST using the registrar endpoint "/.well-known/brski/voucher_status". The Content-Type header is kept as application/jose+json
as described in Figure 14 and depicted in the example in Figure 15.¶
The registrar SHALL verify the signature of the pledge voucher status and validate that it belongs to an accepted device in his domain based on the contained "serial-number" in the IDevID certificate referenced in the header of the voucher status.¶
According to [RFC8995] section 5.7, the registrar SHOULD respond with an HTTP 200 OK in the success case or fail with HTTP 4xx/5xx status codes as defined by the HTTP standard. The registrar-agent may use the response to signal success / failure to the service technician operating the registrar agent. Within the server logs the server SHOULD capture this telemetry information.¶
The registrar SHOULD proceed with collecting and logging status information by requesting the MASA audit-log from the MASA service as described in section 5.8 of [RFC8995].¶
The registrar-agent MUST provide the pledge's enroll status to the registrar. The status indicates the pledge could process the enroll-response (certificate) and holds the corresponding private key.¶
The registrar-agent sends the pledge enroll status without modification to the registrar with an HTTP-over-TLS POST using the registrar endpoint "/.well-known/brski/enrollstatus".
The Content-Type header is kept as application/jose+json
as described in Figure 14 and depicted in the example in Figure 16.¶
The registrar MUST verify the signature of the pledge enroll status. Also, the registrar SHALL validate that the pledge is an accepted device in his domain based on the contained product-serial-number in the LDevID certificate referenced in the header of the enroll status. The registrar SHOULD log this event. In case the pledge enroll status indicates a failure, the pledge was unable to verify the received LDevID certificate and therefore signed the enroll status with its IDevID credential. Note that the verification of a signature of the status information is an addition to the described handling in section 5.9.4 of [RFC8995].¶
According to [RFC8995] section 5.9.4, the registrar SHOULD respond with an HTTP 200 OK in the success case or fail with HTTP 4xx/5xx status codes as defined by the HTTP standard. Based on the failure case the registrar MAY decide that for security reasons the pledge is not allowed to reside in the domain. In this case the registrar MUST revoke the certificate. The registrar-agent may use the response to signal success / failure to the service technician operating the registrar agent. Within the server log the registrar SHOULD capture this telemetry information.¶
The following assumes that a registrar-agent may need to query the status of a pledge. This information may be useful to solve errors, when the pledge was not able to connect to the target domain during the bootstrapping. The pledge MAY provide a dedicated endpoint to accept status-requests.¶
Preconditions:¶
The registrar-agent requests the pledge-status via HTTP POST on the defined pledge endpoint: "/.well-known/brski/pledge-status"¶
The registrar-agent Content-Type header for the pledge-status request is: application/jose+json
.
It contains information on the requested status-type, the time and date the request is created, and the product serial-number of the pledge contacted as shown in Figure 19.
The pledge-status request is signed by registrar-agent using the LDevID(RegAgt) credential.¶
The following Concise Data Definition Language (CDDL) [RFC8610] explains the structure of the format for the pledge-status request. It is defined following the status telemetry definitions in BRSKI [RFC8995]. Consequently, format and semantics of pledge-status requests below are for version 1. The version field is included to permit significant changes to the pledge-status request and response in the future. A pledge or a registrar-agent that receives a pledge-status request with a version larger than it knows about SHOULD log the contents and alert a human.¶
The status-type defined for BRSKI-PRM is "bootstrap". This indicates the pledge to provide current status information regarding the bootstrapping status (voucher processing and enrollment of the pledge into the new domain). As the pledge-status request is defined generic, it may be used by other specifications to request further status information, e.g., for onboarding to get further information about enrollment of application specific LDevIDs or other parameters. This is out of scope for this specification.¶
Figure 20 below shows an example for querying pledge-status using status-type bootstrap.¶
If the pledge receives the pledge-status request with status-type "bootstrap" it SHALL react with a status response message based on the telemetry information described in section Section 6.3.¶
The pledge-status response Content-Type header is application/jose+json
.¶
The following CDDL explains the structure of the format for the status response, which is :¶
Different cases for pledge bootstrapping status may occur, which SHOULD be reflected using the status enumeration. This document specifies the status values in the context of the bootstrapping process and credential application. Other documents may enhance the above enumeration to reflect further status information.¶
The pledge-status response message is signed with IDevID or LDevID, depending on bootstrapping state of the pledge.¶
The reason and the reason-context SHOULD contain the telemetry information as described in section Section 6.3.¶
As the pledge is assumed to utilize the bootstrapped credential information in communication with other peers, additional status information is provided for the connectivity to other peers, which may be helpful in analyzing potential error cases.¶
The pledge-status responses are cumulative in the sense that connect-success implies enroll-success implies voucher-success.¶
Figure 22 provides an example for the bootstrapping-status information.¶
In case "factory-default" the pledge does not possess the domain certificate resp. the domain trust-anchor. It will not be able to verify the signature of the registrar-agent in the bootstrapping-status request. In cases "vouchered" and "enrolled" the pledge already possesses the domain certificate (has domain trust-anchor) and can therefore validate the signature of the registrar-agent. If validation of the JWS signature fails, the pledge SHOULD respond with the HTTP 403 Forbidden status code. The HTTP 406 Not Acceptable status code SHOULD be used, if the Accept header in the request indicates an unknown or unsupported format. The HTTP 415 Unsupported Media Type status code SHOULD be used, if the Content-Type of the request is an unknown or unsupported format. The HTTP 400 Bad Request status code SHOULD be used, if the Accept/Content-Type headers are correct but nevertheless the status-request cannot be correctly parsed.¶
The following enhancement extends the voucher-request as defined in [RFC8995] to include additional fields necessary for handling bootstrapping in the pledge-responder-mode.¶
The following tree diagram is mostly a duplicate of the contents of [RFC8995], with the addition of the fields agent-signed-data, the registrar-proximity-certificate, and agent-signing certificate. The tree diagram is described in [RFC8340]. Each node in the diagram is fully described by the YANG module in Section Section 7.1.2.¶
module: ietf-voucher-request-prm grouping voucher-request-prm-grouping +-- voucher +-- created-on? yang:date-and-time +-- expires-on? yang:date-and-time +-- assertion? enumeration +-- serial-number string +-- idevid-issuer? binary +-- pinned-domain-cert? binary +-- domain-cert-revocation-checks? boolean +-- nonce? binary +-- last-renewal-date? yang:date-and-time +-- prior-signed-voucher-request? binary +-- proximity-registrar-cert? binary +-- agent-signed-data? binary +-- agent-provided-proximity-registrar-cert? binary +-- agent-sign-cert? binary¶
The following YANG module extends the [RFC8995] Voucher Request to include a signed artifact from the registrar-agent (agent-signed-data) as well as the registrar-proximity-certificate and the agent-signing certificate.¶
<CODE BEGINS> file "ietf-voucher-request-prm@2022-07-05.yang" module ietf-voucher-request-prm { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:ietf-voucher-request-prm"; prefix vrprm; import ietf-restconf { prefix rc; description "This import statement is only present to access the yang-data extension defined in RFC 8040."; reference "RFC 8040: RESTCONF Protocol"; } import ietf-voucher-request { prefix vcr; description "This module defines the format for a voucher request, which is produced by a pledge as part of the RFC8995 onboarding process."; reference "RFC 8995: Bootstrapping Remote Secure Key Infrastructure"; } organization "IETF ANIMA Working Group"; contact "WG Web: <http://tools.ietf.org/wg/anima/> WG List: <mailto:anima@ietf.org> Author: Steffen Fries <mailto:steffen.fries@siemens.com> Author: Eliot Lear <mailto: lear@cisco.com> Author: Thomas Werner <mailto: thomas-werner@siemens.com> Author: Michael Richardson <mailto: mcr+ietf@sandelman.ca>"; description "This module defines the format for a voucher-request form the pledge in responder mode. It bases on the voucher-request defined in RFC 8995, which is a superset of the voucher itself. It provides content to the MASA for consideration during a voucher-request. 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) 2021 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 Simplified 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 xxxx; see the RFC itself for full legal notices."; revision 2022-07-05 { description "Initial version"; reference "RFC XXXX: BRSKI for Pledge in Responder Mode"; } // Top-level statement rc:yang-data voucher-request-prm-artifact { // YANG data template for a voucher-request. uses voucher-request-prm-grouping; } // Grouping defined for future usage grouping voucher-request-prm-grouping { description "Grouping to allow reuse/extensions in future work."; uses vcr:voucher-request-grouping { augment voucher { description "Base the voucher-request-prm upon the regular one"; leaf agent-signed-data { type binary; description "The agent-signed-data field contains a JOSE [RFC7515] object provided by the Registrar-Agent to the Pledge. This artifact is signed by the Registrar-Agent and contains a copy of the pledge's serial-number."; } leaf agent-provided-proximity-registrar-cert { type binary; description "An X.509 v3 certificate structure, as specified by RFC 5280, Section 4, encoded using the ASN.1 distinguished encoding rules (DER), as specified in ITU X.690. The first certificate in the registrar TLS server certificate_list sequence (the end-entity TLS certificate; see RFC 8446) presented by the registrar to the registrar-agent and provided to the pledge. This MUST be populated in a pledge's voucher-request when an agent-proximity assertion is requested."; reference "ITU X.690: Information Technology - ASN.1 encoding rules: Specification of Basic Encoding Rules (BER), Canonical Encoding Rules (CER) and Distinguished Encoding Rules (DER) RFC 5280: Internet X.509 Public Key Infrastructure Certificate and Certificate Revocation List (CRL) Profile RFC 8446: The Transport Layer Security (TLS) Protocol Version 1.3"; } leaf-list agent-sign-cert{ type binary; min-elements 1; description "An X.509 v3 certificate structure, as specified by RFC 5280, Section 4, encoded using the ASN.1 distinguished encoding rules (DER), as specified in ITU X.690. This certificate can be used by the pledge, the registrar, and the MASA to verify the signature of agent-signed-data. It is an optional component for the pledge-voucher request. This MUST be populated in a registrar's voucher-request when an agent-proximity assertion is requested. It is defined as list to enable inclusion of further certificates along the certificate chain if different issuing CAs have been used for the registrar-agent and the registrar."; reference "ITU X.690: Information Technology - ASN.1 encoding rules: Specification of Basic Encoding Rules (BER), Canonical Encoding Rules (CER) and Distinguished Encoding Rules (DER) RFC 5280: Internet X.509 Public Key Infrastructure Certificate and Certificate Revocation List (CRL) Profile"; } } } } } <CODE ENDS>¶
Examples for the PVR are provided in Section 6.2.¶
This document requires the following IANA actions.¶
IANA is requested to enhance the Registry entitled: "BRSKI Well-Known URIs" with the following endpoints:¶
URI Description Reference pledge-voucher-request create pledge-voucher-request [THISRFC] pledge-enrollment-request create pledge-enrollment-request [THISRFC] pledge-voucher supply voucher response [THISRFC] pledge-enrollment supply enrollment response [THISRFC] pledge-cacerts supply CA certificates to pledge [THISRFC] pledge-status query pledge status [THISRFC] requestenroll supply PER to registrar [THISRFC] wrappedcacerts request wrapped CA certificates [THISRFC]¶
In general, the privacy considerations of [RFC8995] apply for BRSKI-PRM also. Further privacy aspects need to be considered for:¶
The credential used by the registrar-agent to sign the data for the pledge should not contain any personal information. Therefore, it is recommended to use an LDevID certificate associated with the commissioning device instead of an LDevID certificate associated with the service technician operating the device. This avoids revealing potentially included personal information to Registrar and MASA.¶
The communication between the pledge and the registrar-agent is performed over plain HTTP. Therefore, it is subject to disclosure by a Dolev-Yao attacker (a "oppressive observer")[onpath]. Depending on the requests and responses, the following information is disclosed.¶
In general, the security considerations of [RFC8995] apply for BRSKI-PRM also. Further security aspects are considered here related to:¶
Disrupting the pledge behavior by a DoS attack may prevent the bootstrapping of the pledge to a new domain.¶
A DoS attack with a faked registrar-agent may block the bootstrapping of the pledge due to state creation on the pledge (the pledge may produce a voucher, and refuse to produce another one). One mitigation may be that the pledge does does not limited the number of voucher requests it creates until at least one has finished, or a single onboarding state may expire after a certain time.¶
A registrar-agent that uses previously requested PVR and PER for domain-A, may attempt to onboard the device into domain-B. This can be detected by the domain registrar while PVR processing. The domain registrar needs to verify that the "proximity-registrar-cert" field in the PVR matches its own registrar EE certificate. In addition, the domain registrar needs to verify the association of the pledge to its domain based on the product-serial-number contained in the PVR and in the IDevID certificate of the pledge. (This is just part of the supply chain integration) Moreover, the domain registrar verifies if the registrar-agent is authorized to interact with the pledge for voucher-requests and enroll-requests, based on the LDevID(RegAgt) certificate data contained in the PVR.¶
Misbinding of a pledge by a faked domain registrar is countered as described in BRSKI security considerations [RFC8995] (section 11.4).¶
Concerns on misusage of an registrar-agent with a valid LDevID(RegAgt), may be addressed by utilizing short-lived certificates (e.g., valid for a day) to authenticate the registrar-agent against the domain registrar. The LDevID(RegAgt) certificate may be acquired by a prior BRSKI run for the registrar-agent, if an IDevID is available on registrar-agent. Alternatively, the LDevID may be acquired by a service technician from the domain PKI system in an authenticated way.¶
In addition it is required that the LDevID(RegAgt) certificate is valid for the complete bootstrapping phase. This avoids that a registrar-agent could be misused to create arbitrary "agent-signed-data" objects to perform an authorized bootstrapping of a rouge pledge at a later point in time. In this misuse "agent-signed-data" could be dated after the validity time of the LDevID(RegAgt) certificate, due to missing trusted timestamp in the registrar-agents signature. To address this, the registrar SHOULD verify the certificate used to create the signature on "agent-signed-data". Furthermore the registrar also verifies the LDevID(RegAgt) certificate used in the TLS handshake with the registrar-agent. If both certificates are verified successfully, the registrar-agent's signature can be considered as valid.¶
To discover a specific pledge a registrar-agent may request the service name in combination with the product-serial-number of a specific pledge. The pledge reacts on this if his product-serial-number is part of the request message.¶
If the registrar-agent performs DNS-based Service Discovery without a specific product-serial-number, all pledges in the domain react if the functionality is supported. This functionality enumerates and reveals the information of devices available in the domain. The information about this is provided here as a feature to support the commissioning of devices. A manufacturer may decide to support this feature only for devices not possessing a LDevID or to not support this feature at all, to avoid an enumeration in an operative domain.¶
The enhanced voucher-request described in section Section 7.1 is bases on [RFC8995], but uses a different encoding based on [I-D.ietf-anima-jws-voucher]. Therefore similar considerations as described in [RFC8995] section 11.7 (Security Considerations) apply. The YANG module specified in this document defines the schema for data that is subsequently encapsulated by a JOSE signed-data Content-type as described in [I-D.ietf-anima-jws-voucher]. As such, all of the YANG-modeled data is protected against modification. The use of YANG to define data structures via the "yang-data" statement, is relatively new and distinct from the traditional use of YANG to define an API accessed by network management protocols such as NETCONF [RFC6241] and RESTCONF [RFC8040]. For this reason these guidelines do not follow the template described by [RFC8407] section 3.7 (Security Considerations Section).¶
We would like to thank the various reviewers, in particular Brian E. Carpenter, Oskar Camenzind, and Hendrik Brockhaus for their input and discussion on use cases and call flows. Special thanks to Esko Dijk for the in deep review and the improving proposals.¶
These examples are folded according to [RFC8792] Single Backslash rule.¶
The following is an example request sent from a Pledge to the Registrar-agent, in "General JWS JSON Serialization".
The message size of this PVR is: 4649 bytes¶
The term parboiled refers to food which is partially cooked. In [RFC8995], the term refers to a Pledge voucher-request (PVR) which has been received by the Registrar, and then has been processed by the Registrar ("cooked"), and is now being forwarded to the MASA.¶
The following is an example Registrar voucher-request (RVR) sent from the Registrar to the MASA, in "General JWS JSON Serialization". Note that the previous PVR can be seen in the payload as "prior-signed-voucher-request". The message size of this RVR is: 13257 bytes¶
The following is an example voucher response from MASA to Pledge via Registrar and Registrar-agent, in "General JWS JSON Serialization". The message size of this Voucher is: 1916 bytes¶
The following is an example voucher response from MASA to Pledge via Registrar and Registrar-agent, in "General JWS JSON Serialization". The message size of this Voucher is: 3006 bytes¶
Proof of Concept Code available¶
From IETF draft 04 -> IETF draft 05:¶
From IETF draft 03 -> IETF draft 04:¶
From IETF draft 02 -> IETF draft 03:¶
From IETF draft 01 -> IETF draft 02:¶
From IETF draft 00 -> IETF draft 01:¶
From IETF draft-ietf-anima-brski-async-enroll-03 -> IETF anima-brski-prm-00:¶
From IETF draft 02 -> IETF draft 03:¶
From IETF draft 01 -> IETF draft 02:¶
From IETF draft 00 -> IETF draft 01:¶
From individual version 03 -> IETF draft 00:¶
From individual version 02 -> 03:¶
From individual version 01 -> 02:¶
From individual version 00 -> 01:¶