Internet-Draft | BRSKI-PRM | July 2023 |
Fries, et al. | Expires 11 January 2024 | [Page] |
This document defines enhancements to Bootstrapping a Remote Secure Key Infrastructure (BRSKI, RFC8995) to enable bootstrapping in domains featuring no or only limited connectivity between a pledge and the domain registrar. It specifically changes the interaction model from a pledge-initiated mode, as used in BRSKI, to a pledge-responding mode, where the pledge is in server role. For this, BRSKI with Pledge in Responder Mode (BRSKI-PRM) introduces a new component, the registrar-agent, which facilitates the communication between pledge and registrar during the bootstrapping phase. To establish the trust relation between pledge and registrar, BRSKI-PRM relies on object security rather than transport security. The approach defined here is agnostic to the enrollment protocol that connects 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 11 January 2024.¶
Copyright (c) 2023 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 the BRSKI registrar 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, are exchanged and authenticated utilizing voucher-request and voucher-response artifacts as defined in [RFC8995]. Vouchers are signed objects from the Manufacturer's Authorized Signing Authority (MASA). The MASA issues the voucher and provides it via the domain registrar to the pledge. [RFC8366] specifies the format of the voucher artifacts. [I-D.ietf-anima-rfc8366bis] further enhances the format of the voucher artifacts and also the voucher-request.¶
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 for the authentication and authorization of the certification request on the credentials used by the underlying TLS between the EST client and the EST server.¶
BRSKI addresses scenarios in which the pledge initiates the bootstrapping acting as client (referred to as initiator mode by this document). BRSKI with pledge in responder mode (BRSKI-PRM) defined in this document allows the pledge to act as server, so that it can be triggered to generate bootstrapping requests in the customer site/domain. For this approach, this document:¶
The term endpoint used in the context of this document is equivalent to resource in HTTP [RFC9110] and CoAP [RFC7252]; it is not used to describe a device. Endpoints are accessible via Well-Known URIs [RFC8615]. For the interaction with the domain registrar, the registrar-agent will use existing BRSKI [RFC8995] endpoints as well as additional endpoints defined in this document. To utilize the EST server endpoints on the domain registrar, the registrar-agent will act as client toward the 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 only optionally supported. If TLS is optionally used between the registrar-agent and the pledge, the registrar-agent needs to identify the pledge based on its product serial number rather than the hostname as this is not set in an IDevID certificate.¶
BRSKI-PRM is designed to rely on object security to support also for alternative transports for which TLS may not be available, e.g., Bluetooth or NFC. This is achieved through an additional signature wrapping of the exchanged data objects involving the registrar-agent for transport.¶
To utilize EST [RFC7030] for enrollment, the domain registrar must perform the pre-processing of this wrapping signature before actually using EST as defined in [RFC7030].¶
There may be pledges which can support both modes, initiator and responder mode. 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.¶
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 certificate.¶
Certification Authority, issues certificates.¶
Tool to interact with devices to provide configuration data.¶
Certificate Signing Request.¶
End Entity.¶
term equivalent to resource in HTTP [RFC9110] and CoAP [RFC7252]. Endpoints are accessible via .well-known URIs.¶
mutual 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 on-site. It may be at a central site or an internet resident "cloud" service. The on-site to off-site connection may also be 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), as defined in [RFC5272].¶
Pledge Voucher-Request is a request for a voucher sent to the domain registrar. The PVR is signed by the Pledge.¶
Registration Authority, an optional system component to which a CA delegates certificate management functions such as authorization checks. In BRSKI-PRM this is a functionality of the domain registrar, as in BRSKI [RFC8995].¶
Registrar Enrollment-Request is the CSR of a PER sent to the CA by the domain registrar (RA).¶
Registrar Voucher-Request is a request for a voucher signed by the domain 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 those examples short, they use the token "base64encodedvalue==" as a placeholder for base64 data. The full base64 data is included in the appendices of this document.¶
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 latter is indicated by a string like "BASE64URL(content-name)".¶
BRSKI-PRM is applicable to scenarios where pledges may have no direct connection to the domain registrar, may have no continuous connection, or require coordination of the pledge requests to be provided to a domain registrar.¶
This can be motivated by pledges deployed in environments not yet connected to the operational customer site/domain network, e.g., at a building construction site, or environments intentionally disconnected from the Internet, e.g., critical industrial facilities. Another example is the assembly of electrical cabinets, which are prepared in advance before the installation at a customer site/domain.¶
In building automation a typical use case exists where a detached building or the basement 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, 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 successively collect device-specific information in different parts of the building before connecting to the domain registrar for bulk bootstrapping.¶
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 or other detached areas. These 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. The registrar-agent, defined in this document, may be run on the technician's laptop to interact with pledges.¶
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 physical 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 presumes the availability of the pledge and the registrar-agent to communicate with another. 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. To overcome this situation, the pledges may need to be powered on, either manually or by sending a trigger signal.¶
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 new use cases in which the pledge acts as server. The 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. The format of the bootstrapping objects produced or consumed by the pledge is based on JOSE [RFC7515] and further specified in Section 6 to address the requirements stated in Section 4 above. In constrained environments it may be provided based on COSE [RFC9052] and [RFC9053].¶
An abstract overview of the BRSKI-PRM protocol can be found on slide 8 of [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 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 not shown in the figure, having been replaced by the Registrar Agent. The Join Proxy may still be present, and there MAY be some situations in which the Join Proxy can be used by the Registrar-Agent to connect to the Registrar. For example, the Registrar-Agent application on a smartphone often can connect to local wifi without giving up their LTE connection [androidnsd], but only can make link-local connections.¶
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 described in [RFC8995]. To enable reuse of BRSKI defined functionality as much as possible, BRSKI-PRM:¶
Figure 1 shows the relations between the following main components:¶
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. Any other protocols (including HTTPS) can be used as long as they support the exchange of the necessary data objects. This includes CoAP or protocol to be used over Bluetooth or NFC connections A pledge acting as a server during bootstrapping leads to some differences for BRSKI:¶
"Agent-proximity" is a statement in the PVR and in the voucher, that the 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", which is defined in section 4 of [RFC8366]. "agent-proximity" 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.¶
In BRSKI, the pledge verifies POP of the registrar via the TLS handshake and pins that public key as the "proximity-registrar-cert" into the voucher request. This allows the MASA to see the proximity of the pledge and registrar, facilitating a decision to assign the pledge to that domain owner. In BRSKI, the TLS connection is considered provisional until the pledge receives the voucher.¶
In contrast, in BRSKI-PRM, the pledge has no direct connection to the registrar and must take the Registrar-Agent LDevID provisionally. The registrar-agent has included its LDevID, a certificate signed by the domain owner, into the PVR trigger message. The registrar-agent identity is therefore included into the Pledge Voucher Request (PVR).¶
Akin to the BRSKI case, the pledge has provided proximity evidence to the MASA. But additionally, this allows the Registrar to be sure that the PVR collected by the Registrar-Agent was in fact collected by the Registrar-Agent to which the Registrar is connected to.¶
In a similar fashion, the pledge accepts the registrar certificate provisionally until it receives the voucher as described in Section 6.3. See also Section 5 of [RFC8995] on "PROVISIONAL accept of server cert".¶
The pledge is triggered by the registrar-agent to generate the PVR and PER. It will also be triggered for processing of the responses and the generation of status information once the registrar-agent has received the responses from the registrar later in the process. Due to the use of the registrar-agent, the interaction with the domain registrar is changed as shown in Figure 3. To enable interaction as responder 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 endpoints are defined with short names to also accommodate for the constraint case. The URI path begins with "http://pledge.example/.well-known/brski" followed by a path-suffix that indicates the intended operation.¶
Operations and their corresponding URIs:¶
Operation | Endpoint | Details |
---|---|---|
Trigger pledge voucher-request creation - Returns PVR | /tpvr | Section 6.1 |
Trigger pledge enrollment-request - Returns PER | /tper | Section 6.1 |
Supply voucher to pledge - Returns pledge voucher-status | /svr | Section 6.3 |
Supply enrollment-response to pledge - Returns pledge enrollment-status | /ser | Section 6.3 |
Supply CA certs to pledge | /scac | Section 6.3 |
Query status of pledge - Returns pledge-status | /qps | Section 6.4 |
The registrar-agent as a new component provides a message passing service between the pledge and the domain registrar. 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.¶
The communication between the registrar-agent and the pledge MAY be protected using TLS as outlined in Section 6.1. The details of doing TLS validation are Appendix B.¶
For the communication with the registrar, the registrar-agent uses the endpoints of the domain registrar side already specified in [RFC8995] (derived from EST [RFC7030]) where suitable. These endpoints do not expect signature wrapped-objects, which are used b BRSKI-PRM. This specifically applies for the enrollment-request and the provisioning of CA certificates. To accommodate the use of signature-wrapped object, the following additional endpoints are defined for the registrar. Operations and their corresponding URIs:¶
Operation | Endpoint | Details |
---|---|---|
Supply PER to registrar - Returns enrollment-response | /requestenroll | Section 6.2.6 |
Request (wrapped) CA certificates - Returns wrapped CA Certificates | /wrappedcacerts | Section 6.2.7 |
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 providing the complete LDEVID(RegAgt) certificate to accommodate also constraint environments and reduce bandwidth needed for communication with the pledge. In addition, it follows the recommendation from BRSKI to use SKID 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.3.2) The list may be provided by prior 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. This behavior is retained also in BRSKI-PRM.¶
The following information MUST be available at the registrar-agent before interaction with a pledge:¶
The discovery of the domain registrar may be done as specified in [RFC8995] section 4 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 product-serial-number composition is vendor dependent and may contain information regarding the vendor, the product type, and further information specific to the product instance. To allow distinction of pledges, the product-serial-number therfore needs to be sufficiently unique.¶
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 support this functionality as outlined in Section 10.4.¶
Establishing network connectivity of the pledge is out of scope of this document but necessary to apply mDNS. 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, e.g., as proposed in [I-D.richardson-emu-eap-onboarding]. 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.¶
As an alternative discovery mechanism GRASP M_DISCOVERY multicast with M_RESPONSE, based on [RFC8990], may be used. The specification of this approach to discover a pledge from the registrar-agent is left for further study.¶
Pledges MAY support both initiator or responder mode.¶
A pledge in initiator mode should listen for announcement messages as described in Section 4.1 of [RFC8995]. Upon discovery of a potential registrar, it initiates the bootstrapping to that registrar. At the same time (so as to avoid the Slowloris-attack described in [RFC8995]), it SHOULD also respond to the triggers for responder mode described in this document.¶
Once a pledge with combined functionality has been bootstrapped, it MAY act as client for enrollment of further certificates needed, e.g., using the enrollment protocol of choice. If it still acts as server, the defined BRSKI-PRM endpoints to trigger a pledge enrollment-request (PER) or to provide an enrollment-response can be used for further certificates.¶
The interaction of the pledge with the registrar-agent may be accomplished using different transport means (protocols and/or network technologies). This specification utilizes HTTP as transport. 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 and stay the same across the communication from the pledge via the registrar-agent to the registrar.. 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 LDevID 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), as described in Section 6.1. This enables the registrar to verify and log, which registrar-agent was in contact with the pledge, when verifying the PVR.¶
The registrar MUST provide the LDevID(RegAgt) certificate identified by the SubjectKeyIdentifier (SKID) in the header of the agent-signed-data from the PVR in its RVR (see also pvr-proc-reg.¶
The MASA in turn verifies the registrar LDevID certificate is included in the PVR (contained in the "prior-signed-voucher-request" field of RVR) in the "agent-provided-proximity-registrar-certificate" leaf and may assert the PVR as "verified" or "logged".¶
In addition, the MASA can issue 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. This agent-proximity is similar to the proximity assertion by the MASA when using BRSKI. It is a stronger assertion than "logged", but it is weaker than the assertion "verified", which relies on ownership tracking.¶
Depending on the MASA verification policy, it may also respond with a suitable 4xx or 5xx error status code as described in section 5.6 of [RFC8995]. When successful, the voucher will then 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 shown in Figure 2 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.3.2 and Figure 2 based on DNS-SD or similar.¶
The focus is on the exchange of signature-wrapped objects using endpoints defined for the pledge in Section 5.2.¶
Preconditions:¶
Registrar-agent:¶
possesses own LDevID(RegAgt) credentials for the registrar domain (site). In addition, the registrar-agent SHOULD 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:¶
The registrar-agent SHOULD have synchronized time.¶
TLS MAY be optionally used to provide privacy for the interaction between the registrar-agent and the pledge, see Appendix B.¶
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/tpvr"¶
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:¶
Note that at the time of receiving the PVR trigger, the pledge cannot verify the registrar LDevID certificate and has no proof-of-possession of the corresponding private key for the certificate. The pledge therefore accepts the registrar LDevID certificate provisionally until it receives the voucher as described in Section 6.3.¶
The pledge will also 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. Verification 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:agent-signed-data" element (defined in [I-D.ietf-anima-rfc8366bis]):¶
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] to support JWS signing of the object:¶
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 extended with additional parameters:¶
The enhancements of the YANG module for the ietf-voucher-request with these new leaves are defined in [I-D.ietf-anima-rfc8366bis].¶
The PVR is signed using the pledge's IDevID credential contained as x5c parameter of the JOSE header.¶
The PVR Media-Type is defined in [I-D.ietf-anima-jws-voucher] as application/voucher-jws+json
.¶
The pledge MUST include this Media-Type header field indicating the included media type for the PVR. The PVR is included by the registrar in its RCR 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/tper"¶
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.¶
This document specifies the request of a generic certificate with no CSR attributes provided to the pledge. If specific attributes in the certificate are required, they have to be inserted by the issuing RA/CA. How the HTTP POST can be used to provide CSR attributes is out of scope for this specification.¶
In the following the enrollment is described as initial enrollment with an empty HTTP POST body.¶
Upon receiving the PER trigger, the pledge SHALL construct the PER as authenticated self-contained object. The CSR already assures POP of the private key corresponding to the contained public key. In addition, based on the PER signature using the IDevID, POI 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 pledge 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 MUST 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 of the PER 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 JOSE object is signed using the pledge's IDevID credential, which corresponds to the certificate signaled in the JOSE header.¶
While BRSKI-PRM targets the initial enrollment, re-enrollment SHOULD be supported as described in a similar way as for enrollment in this document, if no other re-enrollment mechanism is supported. Note that in this case the current LDevID credential is used instead of the IDevID credential to create the signature of the PKCS#10 request.¶
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. The registrar MAY consider to ignore any but the newest PER from the same pledge in the case the registrar has at any point in time more than one pending PER from the pledge.¶
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 SHOULD 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.¶
With BRSKI-PRM, the pledge generates PVR and PER as JSON-in-JWS objects and the registrar agent forwards them to the registrar. In [RFC8995], the pledge generates PVR as CMS-signed JSON and PER as PKCS#10 or PKCS#7 according to [RFC7030] and inherited by [RFC8995].¶
For BRSKI-PRM, the registrar agent sends the PVR by HTTP POST to the same registrar endpoint as introduced by BRSKI: "/.well- known/brski/requestvoucher", but with a Content-Type header field for JSON-in-JWS"¶
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 sets the Accept field in the request-header indicating the acceptable Content-Type for the voucher-response.
The voucher-response Content-Type header field is 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 registrar is unable to validate the PVR it SHOULD respond with a HTTP 4xx/5xx error code to the registrar-agent.¶
The following 4xx client error codes SHOULD be used:¶
If the validation succeeds, the registrar performs pledge authorization according to [RFC8995], Section 5.3 followed by obtaining a voucher from the pledge's MASA according to [RFC8995], Section 5.4 with the modifications described below in Section 6.2.3.¶
If the MASA address/URI is learned from the [RFC8995] Section 2.3 IDevID MASA URI extension, then the MASA on that URI MUST support the procedures defined in this document if the PVR used JSON-JWS encoding. If the MASA is only configured on the registrar, then a registrar supporting BRKSI-PRM and other voucher encoding formats (such as those in [RFC8995]) SHOULD support per-message-format MASA address/URI configuration for the same IDevID trust anchor."¶
The registrar SHALL construct the payload of the RVR as defined in [RFC8995], Section 5.5. 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 extended with the following parameter, when the assertion "agent-proximity" is requested, as defined in [I-D.ietf-anima-rfc8366bis]:¶
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 LDevID 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 MASA creates a voucher with Media-Type of application/voucher-jws+json
as defined in [I-D.ietf-anima-jws-voucher].
If the MASA detects that the Accept header of the PVR does not match 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 is according to [I-D.ietf-anima-rfc8366bis] but uses the new assertion value specified Section 5.1.¶
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 LDevID credentials (see [RFC7515], Section 5.2 point 8. The x5c component of the "JWS Protected Header" MUST contain the registrar LDevID 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 POP of the private key corresponding to the registrar LDevID certificate the pledge received in the trigger for the PVR (see Figure 4). The registrar MUST use the same registrar LDevID credentials used for authentication in the TLS handshake to authenticate towards the registrar-agent. This ensures that the same registrar LDevID 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 in the same HTTP-over-TLS connection. Which is similar to the PER processing described in Section 5.2 of [RFC8995]. In case the PER cannot be send in the same HTTP-over-TLS connection the registrar-agent may send the PER in a new HTTP-over-TLS connection. The registrar is able to correlate the PVR and the PER based on the signatures and the contained product-serial-number information. Note, this also addresses situations in which a nonceless voucher is used and may be pre-provisioned to the pledge. As specified in Section 6.1.4 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.¶
Note while BRSKI-PRM targets the initial enrollment, re-enrollment may be supported in a similar way with the exception that the current LDevID certificate is used instead of the IDevID certificate to verify the wrapping signature of the PKCS#10 request (see also Section 6.1.4).¶
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 LDevID 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:¶
To deliver these response objects, the registrar-agent will re-connect to the pledge. To contact the pledge, it may either discover the pledge as described in Section 5.3.2 or use stored information from the first contact with the pledge.¶
Preconditions in addition to Section 6.2:¶
The registrar-agent MAY optionally use TLS to protect the communication as outlined in Section 6.1.¶
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/svr".¶
The registrar-agent voucher-response Content-Type header is application/voucher-jws+json
and contains the voucher as provided by the MASA. An example is 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 manufacture's pledge implementation.¶
To perform the validation of several signatures on the voucher object, the pledge SHALL perform the signature verification in the following order:¶
Step3 and step 4 have been introduced in BRSKI-PRM to enable verification of LDevID(Reg) certificate and also the proof-of-possession of the corresponding private key by the registrar, which is done in BRSKI based on the established TLS channel. 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 LDevID 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.¶
If the pledge did not did not provide voucher status telemetry information after processing the voucher, the registrar agent MAY query the pledge status explicitly as described in Section 6.4 and MAY re-sent the voucher depending on the Pledge status following the procedure described in Section 6.3.1.¶
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/scac".¶
As the CA certificate provisioning is crucial from a security perspective, this provisioning SHOULD only be done, if the voucher-response has been successfully processed by pledge as reflected in the voucher status telemetry.¶
The CA certificates message has the Content-Type application/jose+json
and is signed using the credential of the registrar 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.¶
The following 4xx client error codes SHOULD be used by the pledge:¶
The registrar-agent SHALL send the enroll-response to the pledge by HTTP POST to the endpoint: "/.well-known/brski/ser".¶
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 property SHALL be set to "status": true, otherwise to "status": 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 to provide it with the status responses.¶
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.¶
In case the TLS connection to the registrar is already closed, the registrar-agent opens a new 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 of the 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 of the 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 signature verification of the status information is an addition to the described handling in Section 5.9.4 of [RFC8995], and is replacing the pledges TLS client authentication by DevID credentials in [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. An example case for the registrar revoking the issued LDevID for the pledge is when the pledge was not able to verify the received LDevID certificate and therefore did send a 406 (Not Acceptable) response. In this case the registrar may revoke the LDevID certificate as the pledge did no accepted it for installation.¶
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/qps"¶
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 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 6.3.¶
As the pledge is assumed to utilize its bootstrapped credentials (LDevID) 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, which in turn implies voucher-success.¶
Figure 22 provides an example for the bootstrapping-status information.¶
The pledge SHOULD by default only respond to requests from nodes it can authenticate (such as registrar agent), once the pledge is enrolled with CA certificates and a matching domain certificate.¶
[I-D.ietf-anima-rfc8366bis] extends the voucher-request as defined in [RFC8995] to include additional fields necessary for handling bootstrapping in the pledge-responder-mode. These additional fields are defined in Section 6.1 as:¶
Examples for the application of these fields in the context of a 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 tpvr create pledge voucher-request [THISRFC] tper create pledge enrollment-request [THISRFC] svr supply voucher-response [THISRFC] ser supply enrollment-response [THISRFC] scac supply CA certificates to pledge [THISRFC] qps 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:¶
Section 6.1 describes to optional apply TLS to protect the communication between the registrar-agent and the pledge. The following is therefore applicable to the communication without the TLS protection.¶
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 (an "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 changing state on the pledge (the pledge may produce a voucher-request, and refuse to produce another one). One mitigation may be that the pledge does not limited the number of voucher-requests it creates until at least one has finished. An alternative may be that the onboarding state may expire after a certain time, if no further interaction has happened.¶
In addition, the pledge may assume that repeated triggering for PVR are the result of a communication error with the registrar-agent. In that case the pledge MAY simply resent the PVR previously sent. Note that in case of resending, a contained nonce and also the contained agent-signed-data in the PVR would consequently be reused.¶
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 LDevID 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 of misusage of a 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 rogue 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 its 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 [I-D.ietf-anima-rfc8366bis] is based on [RFC8995], but uses a different encoding based on [I-D.ietf-anima-jws-voucher]. The security considerations as described in [RFC8995] Section 11.7 (Security Considerations) apply.¶
The YANG module specified in [I-D.ietf-anima-rfc8366bis] 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 [RFC8971] "structure" 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, Hendrik Brockhaus, and Ingo Wenda for their input and discussion on use cases and call flows. Further review input was provided by Jesser Bouzid, Dominik Tacke, and Christian Spindler. Special thanks to Esko Dijk for the in deep review and the improving proposals. Support in PoC implementations and comments resulting from the implementation was provided by Hong Rui Li and He Peng Jia.¶
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¶
The use of HTTPS between the Registrar-Agent and the Pledge has been identified as an optional mechanism.¶
Provided that the key-agreement in the underlying TLS protocol connection can be properly authenticated, the use of TLS provides privacy for the voucher and enrollment operations between the pledge and the registrar-agent. The authenticity of the onboarding and enrollment is not dependant upon the security of the TLS connection.¶
The use of HTTPS is not mandated by this document for a number of reasons:¶
If the Registrar-Agent has a preconfigured list of which serial numbers, from which manufacturers it expects to see, then it can attempt to match this pledge against a list of potential devices.¶
In many cases only the list of manufacturers is known ahead of time, so at most the Registrar-Agent can show the X520SerialNumber to the (human) operator who may then attempt to confirm that they are standing in front of a device with that serial number. The use of scannable QRcodes may help automate this in some cases.¶
Proof of Concept Code available¶
From IETF draft 08 -> IETF draft 09:¶
From IETF draft 07 -> IETF draft 08:¶
From IETF draft 06 -> IETF draft 07:¶
From IETF draft 05 -> IETF draft 06:¶
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:¶