Welcome to the OpenID Federation Browser project!
This tool is designed to facilitate the exploration of trust infrastructures based on OpenID Federation 1.0, providing a user-friendly interface for navigating Trust Chains and Entity Configurations.
- Entity Discovery: Easily discover and view OpenID Federation Entities and their configurations.
- Trust Chain Visualization: Visualize the Trust Chains between entities, including Trust Anchors, Intermediates, and Leaves.
- Graph View Save, Export and Import: Produce the representation of your network, save locally or export it. You can also import it in offline mode.
- [TODO] Security Insights: Gain insights into the security aspects of the federation, including trust marks and compliance status.
The stable version of OpenID Federation Browser is usable online here
Snapshot build of the dev version is available here.
Please remember to bypass CORS restrictions using a web browser addon or proxy before using it. See here to learn how to do.
To install and run the OpenID Federation Browser, follow these steps documented in here.
- Configure the Trust Anchor: Submit the https URL of the Trust Anchor to use and optionally its Federation Entity Keys in JWK format.
- Browse Subordinates: inspect the Entities listed in the Federation Listing Endpoint and find Leaves and Intermediates.
- Filter Subordinates: filter results using regexp on the entity IDs or Federation Listing url params filters.
- Discover Entities: Submit a specific entity id to be resolved under the configured Trust Anchor.
- Inspect Entity Statements: inspect Entity Configuration by clicking an Entity, Subordinate Statements by clicking the wire connecting an Entity with its Superior.
- Export Trust Chains: By selecting a specific Entity, download the validated Trust Chain.
- Security Checks: Inspect specific Trust Marks associated with each entity.
We welcome contributions to the OpenID Federation Browser project! Here’s how you can get involved:
The project uses JSON schemas to inspect entities. If you want to contribute to the schema definitions, you can find the current schemas here:
Feel free to propose changes or improvements by opening a Pull Request (PR).
We support localization and you can help by adding or updating translations. To add Swedish localization, create a sv.json file based on the existing English localization file and submit it via a PR. Additionally, update the translations.ts file to include the new language.
The trust anchor list is an important part of the OpenID Federation Browser distribution. If you have updates or additions to the trust anchor list, please update the trustChainList.json file and submit your changes via a PR.
- Fork the Repository: Start by forking the repository to your GitHub account.
- Clone Your Fork: Clone your forked repository to your local machine.
- Create a Branch: Create a new branch for your feature or bug fix.
- Make Changes: Implement your changes in the codebase.
- Commit Your Changes: Make sure to write clear and concise commit messages.
- Push to GitHub: Push your changes to your forked repository.
- Open a Pull Request: Navigate to the original repository and open a pull request with a description of your changes.
We appreciate your contributions and look forward to collaborating with you!
To test the application start the development server using "npm run start" and in a separate shell run the following command:
npx cypress open
At this point select E2E testing and one of the installed browser as a platform. For the correct functioning it's necessary install a CORS Plugin (see here) and enabling it before the tests start.
Open a PR adding your favorite Trust Anchors here.
This project is licensed under the Apache2 License. See the LICENSE file for more details.
For questions or support, please open github issues or contact [email protected].