UDAP SDK and reference implementation for .NET.
In short UDAP is a PKI extension profile to OAuth2. One or more PKIs can be hosted by a Community. Joining a Community results in a public/private key issued to a client. The client also chooses to explicitly trust one of the issuing certificates in that chain by installing in your client. In addition, all certificate chain validation including certificate revocation to a trusted root are performed.
Note: This is a new project. It will take me some time to document. It should be very active in code changes and document additions. But feel free to try it out and add issues and/or pull requests.
Many example apps are in the examples folder.
- FHIR® is the registered trademark of HL7 and is used with the permission of HL7. Use of the FHIR trademark does not constitute endorsement of the contents of this repository by HL7.
- UDAP® and the UDAP gear logo, ecosystem gears, and green lock designs are trademarks of UDAP.org. UDAP Draft Specifications are referenced and displayed in parts of this source code to document specification implementation.
The repository contains components and example uses to support the following items from Security for Scalable Registration, Authentication, and Authorization. The intent is to also support generic UDAP, but the driving force currently is supporting auto registration to FHIR® servers.
| Feature | Sub Feature | Supported | Comments |
|---|---|---|---|
| Udap.Client | |||
| UDAP Metadata Validation | ✔️ | Validates JWT and Certificates. See Udap.Client for usage. | |
| Dynamic Client Registration | ✔️ | Functionally DCR exists but it has not been packaged and documented in Udap.Client package. | |
| Access Token | ✔️ | Functionally exists and needs to be packaged and documented in Udap.Client packages | |
| hl7-b2b extension | In process | This is hard coded in the UdapEd tool for illustration and to pass registration against Authorization Servers that require it. It is a required claim when requesting an access token in the client_credentials grant type flow profiles by UDAP Security under HL7 FHIR. I don't know if it stays here as a feature yet. I do want to call it out because it is a very meaningful feature of UDAP in the HL7 FHIR use case. | |
| Discovery: UDAP Metadata for Resource Server | |||
| Udap.Metadata.Server | ✔️ Including Multi Trust Communities | Certificate storage is a file strategy. User can implement their own ICertificateStore. May add a Entity Framework example and/or HSM in the future. Checkout the 2023 FHIR® DevDays Tutorial to see it in action and the Udap.Metadata.Server docs | |
| Udap.Metadata.Vonk.Server | Trial status. Including Multi Trust Communities | This is based on the same components that build Udap.Metadata.Server. It can be used as a plugin for the Firely server. It has been tested on the Community edition. Readme more in the docs
|
|
| Server Dynamic Registration | ✔️ Including Multi Trust Communities. | Highly Functional. The Deployed example FHIR® Server, "FhirLabsApi" is passing all udap.org Server Tests. I am going to revisit the Client Secrets persistence layer. Packages are dependent on Duende's Identity Server Nuget Packages.
Notes: Since this development, the Identity Server has Implemented Dynamic Registration. We could revisit this and try to enable UDAP under the new DCR feature. |
|
| Inclusion of Certifications and Endorsements | Started | Some example certification integration tests included from the client side | |
| Authorization and Authentication | |||
| Consumer-Facing | ✔️ | Functionality same as B2B authorization_code flow. Client would typically register and or request user/* prefixed scopes | |
| Business-to-Business | ✔️ | Works with client_credentials and authorization_code flows. | |
| JWT Claim Extensions | Started | Some work completed for the B2B Authorization Extension (hl7-b2b) extension within integration tests. } | |
| Tiered OAuth for User Authentication | ✔️ | Simply register Tiered OAuth functionality with the code snippet below. There is a good integration test called ClientAuthorize_IdPDiscovery_IdPRegistration_IdPAuthAccess_ClientAuthAccess_Test. This spins up two in memory instances of Identity Server. One plays the role of Authorization Server and the other plays the role of Identity Provider. This test harness is important to quickly test Tiered OAuth without a user interface. When I built this first implementation, I was inspired by other implementations such as this great collection from the aspnet-contrib organization, called AspNet.Security.OpenId.Providers. There is another repository at this organization, called AspNet.Security.OpenId.Providers. |
builder.Services.AddAuthentication()
.AddTieredOAuth(options =>
{
options.SignInScheme = IdentityServerConstants.ExternalCookieAuthenticationScheme;
});Part of this repository is a xUnit test project that will generate a couple PKI hierarchies for testing UDAP. The test is called Udap.PKI.Generator. I think showing the mechanics of what it takes to build out a PKI for UDAP will aid education and provide the flexibility to test interesting use cases. Run all the tests in the Udap.PKI.Generator project. The results include a folder with root a root certificate authority that issues intermediate certificates, certificate revocation lists, used certificates for community members and certs for web TLS certs. Each of the example web services located in the examples use MSBuild Links to link to certificates appropriate to its PKI needs. So, if you would like to change something in the PKI just edit and run the tests. All examples will automatically pick up the changes. To enable crl lookup and AIA, Certification Authority Issuer resolution I just mapped crl, cert and anchor as static content via something like IIS on my Windows box. I may create a dotnet core app to make this easier and it into ci/cd better but this is where I am at so
I am not sure if this will stay in unit test form or not, but for now this is the technique.
A .NET UI and CLI tool to generate certificates for UDAP communities. A UI version of this tool is partially done in the Udap.CA project. The plan is to deploy this or install it yourself and allow quick generations of certificates and PKI hierarchies that can generate valid and various invalid certificates for testing to aid in experimenting with behaviors such as certificate revocation, expirations and other interesting potential certification use cases.
See the following Udap.Metadata.Server and Udap.Server sections. The Udap.Metadata.Server is for the resource server such a FHIR® Server. Udap.Server.Server is for the Identity Server.
Follow the Udap.Metadata.Server docs for configuring your resource server.
Follow the Udap.Client docs for configuring your UDAP client.
Follow the Udap.Server docs for configuring your UDAP client.
From root.
dotnet restoreIf this is first build or you want to reset you certificates change to /_tests/Udap.PKI.Generator. This must be done once. Other projects are dependent on a lab environment with test PKIs. This is good in that the development experience will always have PKI structures that do not contain expired certificates unless that is an intended artifact of the data set.
dotnet testReturn to root
dotnet buildAgain it is probably best to avoid running Udap.PKI.Generator unless you need the certificates regenerated. I may migrate this away from unit test in future. Or create a src folder to isolate.
It is also best to avoid Udap.Client.System.Tests as they are for experimenting with live servers. Eventually the FhirLabs UdapEd client tool will replace the need for this.
The following tests are normal to run and the build server runs these same tests.
- Udap.CA.Tests
- Udap.Common.Tests
- Udap.Support.Tests
- UdapMetadata.Tests, tests two against the two example web services, FhirLabsApi and WeatherApi.
- UdapServer.Tests. There are times when the bin folder should be deleted because the SQLite DB gets out of sync with the PKI artifacts because the Udap.PKI.Generator tests were ran after the SQLite database is created.
This is a MVP version of an Admin UI Tool. It is only capable of administering the Udap prefixed tables.
This is barely implemented. The spirit of it is to create a easy to use CA for experimenting in a lab environment. At this point all the tooling for creating interesting PKI test data for success and failure use cases lives in the Udap.PKI.Generator test project.
Turn your FHIR server into a UDAP secured FHIR server with Udap.Proxy.Server.
