REAMDE.md
SAML Jackson: Open Source Enterprise SSO And Directory Sync
SAML Jackson bridges or proxies a SAML login flow to OAuth 2.0 or OpenID Connect, abstracting away all the complexities of the SAML protocol. It also supports Directory Sync via the SCIM 2.0 protocol for automatic user and group provisioning/de-provisioning.
We now also support OpenID Connect providers.
Directory Sync
SAML Jackson also supports Directory Sync based on the SCIM 2.0 protocol.
Directory sync helps organizations automate the provisioning and de-provisioning of their users. As a result, it streamlines the user lifecycle management process by saving valuable organizational hours, creating a single truth source of the user identity data, and facilitating them to keep the data secure.
For complete documentation, visit boxyhq.com/docs/directory-sync/overview
🌟 Why star this repository?
If you find this project helpful, please consider supporting us by starring the repository and sharing it with others. This helps others find the project, grow the community and ensure the long-term health of the project. 🙏
- SAML Jackson: Open Source Enterprise SSO And Directory Sync
🚀 Getting Started with SAML Jackson
There are two ways to integrate SAML Jackson into an application. Depending on your use case, you can choose either of them.
- As a separate service (Next.js application) This includes an admin portal out of the box for managing SSO and Directory Sync connections.
- NPM library as an embedded library in your application.
Try A Demo
- Try our hosted demo showcasing the SAML service provider (SP) initiated login flow here, which uses our Mock SAML IdP service.
- Try an Identity Provider (IdP) initiated login flow here.
Deploying SAML Jackson as a separate service locally
Let's get you to Hello SAML Jackson in no time.
Prerequisites
- Node.js at version
18.14.2or higher
It is generally a good idea to install and maintain Node.js versions using a version manager like nvm or nvs on Windows. More information is available here.
Clone the repository
git clone https://github.com/boxyhq/jackson.git
cd jackson
Install dependencies
npm i
Setup environment variables
Create a .env from the existing .env.example file in the root of the project.
cp .env.example .env
Environment variable documentation: Have a look at https://boxyhq.com/docs/jackson/deploy/env-variables for all of the available environment variables.
Database
For the rest of the setup, we will use a PostgreSQL database. The easiest way to get PostgreSQL up and running on macOS is by using Postgres.app. You can download it from https://postgresapp.com/.
For other operating systems and alternative options for MacOS, please see the documentation available on the Prisma website.
Start the development server
Instead of running it locally you could also run docker compose up and run a specific version of Jackson. For running it locally continue to follow the instructions below.
Now that we have our database running we can start the development server. But before we do, we need a way to log into the admin portal.
To log in to the admin portal we either need to configure magic links, or enable username and password login. The easiest one, and the one we will use, is to enable username and password login.
In your .env find the NEXTAUTH_ADMIN_CREDENTIALS environment variable. We need to provide an email:password combination that we can then use to log in to the admin portal. For example:
NEXTAUTH_ADMIN_CREDENTIALS=admin@example.com:password
Now we can start the development server:
npm run dev
Open http://localhost:5225 in your browser and you should be redirected to the login screen.
At the login screen, you can now use the username and password you set in the NEXTAUTH_ADMIN_CREDENTIALS environment variable to log in. Click "Sign In" and you should be logged in and see the SSO Connections page with no configured connections. We have reached Hello SAML Jackson!
Documentation
For the full documentation, visit boxyhq.com/docs/jackson/overview
Easy Cloud Deployment
Deploy SAML Jackson to the cloud with a single click using the following providers:
Videos
- SSO/OIDC Tutorial SAML Jackson Enterprise SSO (split into chapters to easily find what you are looking for)
- SAML single sign-on login demo
End-to-End (E2E) tests
Create a .env.test.local file and populate the values. To execute the tests run:
npm run test:e2e
About BoxyHQ
BoxyHQ is on a mission to democratize enterprise readiness for developers one building block at a time. We are building a suite of security building blocks that are easy to use and integrate into your applications. Our goal is to make being enterprise-ready accessible to all developers, founders, and those responsible for the security of their internal applications regardless of their security expertise.
Community is core to our mission. We are building a community of developers, security enthusiasts, and founders who are passionate about security and building secure applications. We are building in the open and would love for you to join us on this journey.
Join the community on Discord today.
Security And Observability
Observability
We support first-class observability on the back of OpenTelemetry, refer here for more details.
SBOM Reports (Software Bill Of Materials)
We support SBOM reports, refer here for more details.
Container Signing and Verification
We support container image verification using cosign, refer here for more details.
🛡️ Reporting Security Issues
Contributing
Thank you for your interest in contributing to SAML Jackson! We are excited to welcome contributions from the community. Please refer to our contributing guidelines for more information.
💫 Support
Reach out to the maintainers at one of the following places: