Skip to content
This repository has been archived by the owner on Jul 19, 2023. It is now read-only.

Latest commit

 

History

History
77 lines (50 loc) · 3.38 KB

README.md

File metadata and controls

77 lines (50 loc) · 3.38 KB
Raw

client-identifier-helper

Contributor Covenant

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

A tool to create and validate Client Identifier Documents. You can find a live version here.

This web application provides a validator and a generator for Solid Client Identifier Documents, to help developers set up their Solid apps.

Technical Details

Client Identifier Documents are used to identify the client to a Solid-OIDC provider. They describe client metadata conventionally provided in static or dynamic client registration in OpenID Connect. A Solid Client Identifier is a Universal Resource Identifier (URI) that points to the Client Identifier Document, allows Resource Servers to uniquely identify the client, show the user rich information when granting access, and enforce access control tied to the client.

Advantages of Solid OpenID Connect in contrast to OpenID Connect Dynamic Client Registration

In contrast to OpenID Connect (OIDC) dynamic client registration, Client Identifier Documents offer several advantages:

  • They have a dereferencable URI under the control of the client, which works better in a decentralized ecosystem, as there is no need for the Authorization Server to have advanced knowledge of the client.
  • Because the Solid Client Identifier is a unique universal client identity, the Resource Servers can enforce client-specific access control.

Installation for Development

To install the latest version of the Client Identifier Helper locally, run:

git clone https://github.com/inrupt/client-identifier-helper.git
cd client-identifier-helper
npm install

Then, to develop the application, run:

npm run dev

To run the application as if was deployed, run:

npm run build
npm run preview

Issues & Help

Solid Community Forum

If you have questions about working with Solid or just want to share what you’re working on, visit the Solid forum. The Solid forum is a good place to meet the rest of the community.

Bugs and Feature Requests

  • For public feedback, bug reports, and feature requests please file an issue via Github.
  • For non-public feedback or support inquiries please use the Inrupt Service Desk.

Documentation

Changelog

This project is continuously released to vercel using the main branch.

License

MIT © Inrupt