Start with the documents in this section if you want to evaluate or integrate LinkKeys.
In these documents, an RP server is a LinkKeys server that has the RP function enabled. It can be a dedicated RP server, or it can be an IDP server that also has the RP function enabled. The combined IDP and RP configuration is the common configuration.
- Authentication and claims flow explains the components, API operations, web login sequences, claim release, and application responsibilities.
- Deploy a relying party explains how to run the LinkKeys server that holds an application domain's keys.
- Regular-RP SDKs lists the complete SDKs and the lower-level generated bindings.
- Build a local-RP app is for an application that does not have public DNS.
- Protocol specification is the normative interoperability specification.
- Design explains the project goals and architecture.
- Claim trust and verification explains how identities, subjects, profiles, and claim signatures relate.
- Claim policy and consent explains claim types, signing rules, release policy, and user consent.
- Application keys explains how an application holds its own keys, how the home domain attests them, and how a peer verifies them.
- Deploy a relying party
- Deploying at scale explains file-descriptor limits, the TCP listen backlog, connection tracking, and why the protocol port needs an L4 passthrough path, not an HTTP ingress.
- Load testing the TCP server explains the connection, handshake, cache, and DDoS load-test harness, and records one measured run.
- Local-RP operator guide
- Local-RP administrator guide
- Local-RP key lifecycle
- Upgrade LinkKeys
Documents outside docs/spec/ describe this implementation. If an
implementation document conflicts with the protocol specification, the
specification controls interoperability.