Skip to content

Ig 1.10.0 development 4 LD#515

Merged
luci-davies merged 4 commits intodevelopfrom
IG-1.10.0-Development-4-LD
Oct 21, 2025
Merged

Ig 1.10.0 development 4 LD#515
luci-davies merged 4 commits intodevelopfrom
IG-1.10.0-Development-4-LD

Conversation

@luci-davies
Copy link
Collaborator

No description provided.

@luci-davies luci-davies requested a review from cda69 October 21, 2025 12:43

## {{page-title}}

BaRS uses TLS-MA to communicate with Receiving endpoints. Receiving endpoints need a certificate under the NHS Root CA to facilitate TLS-MA. The receiver needs to follow these steps for Integration and Production environments.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The receiver needs to follow these steps to access Integration (INT) and Production (PROD) environments.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested changes made.


BaRS uses TLS-MA to communicate with Receiving endpoints. Receiving endpoints need a certificate under the NHS Root CA to facilitate TLS-MA. The receiver needs to follow these steps for Integration and Production environments.

To onboard as a receiver follow these steps:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is 'onboard' the right term? I think 'connect' or 'access' might be more appropriate

Step 1: Apply for your domain [apply for a new nhs.uk domain](https://digital.nhs.uk/services/networking-addressing/apply-for-an-nhs.uk-domain-for-websites-and-web-applications). You must complete Section 5: For website or application records visible on the public internet.

Step 2: Request a certificate under the NHS Root CA. The FQDN must be an nhs.uk address.
* There are different certificate chains for INT and PROD
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The detail about cert chains feels wrong here. It's only important once the cert is received.

openssl req -new -key private.key -out request.csr
```

Step 4: Send the .csr file to be signed by the NHS and get the client certificate. To do this, follow these environment specific steps:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NHSE

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change made (NHS England)

Step 3: Email <england.bookingandreferralstandard@nhs.net> with Receiver URL for BaRS/API-M to add to the Endpoint Catalogue

#### Client certificate: Production (PROD)
Production endpoints can only be requested when Solution Assurance issue the supplier with the Technical Conformance certificate,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make the note about having a TCC bold or highlighted in a different colour

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change made

Step 2: Receive certificate from DIR Team
Step 3: Email <england.bookingandreferralstandard@nhs.net> with Receiver URL for BaRS/API-M to add to the Endpoint Catalogue

Step 4: INT and PROD copy the cert text inlcuding `-----BEGIN CERTIFICATE` as the first line and `END CERTIFICATE-----` as the last. Save this text locally as a file called barsinreceiver.cer (change the name to suit).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

technically, the supplier should know what to do with the cert once they have it signed. steps 4-7 could be a separate section on installing and configuing their solution to use the cert.

That way we keep our actual steps down to 2-3 a piece.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change made

listenOptions.UseHttps(certPath, certPassword);
});
});

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a link to Firewall changes here too

Copy link
Collaborator

@cda69 cda69 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added some comments for change/consideration

@luci-davies luci-davies merged commit 7d2235a into develop Oct 21, 2025
1 check failed
@luci-davies luci-davies deleted the IG-1.10.0-Development-4-LD branch October 21, 2025 15:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

Comments