oxd 3.0.1 Documentation#
oxd is a middleware service that simplifies and standardizes the process of integrating server-side web applications with a standard OpenID Connect Provider (OP) like the Gluu Server.
If you need to integrate other types of apps with your Gluu Server, like single-page apps (SPAs) or native apps, review the SSO integration guide in the Gluu Server documentation.
The oxd server is designed to work as a standalone service demon via sockets. By default, the oxd-server is restricted to
localhost, which means oxd needs to be installed on each server hosting applications you want secured.
oxd exposes a simple REST API and native libraries that wrap the API for Php, Java, Python, Node, Ruby C#, and .Net.
License & Billing#
oxd is commercial software licensed by Gluu. The billing model is $0.33 per server per day (or roughly $10 per month per server).
To complete the oxd-server setup you will need a valid license. Get your license and a $50 credit on the oxd website.
How it Works#
User clicks login at your web app;
Your web app uses oxd's REST API or one of its native libraries for java, python, node, ruby, c#, pearl, or go to securely send the user to an OpenID Provider (OP) for login;
oxd communicates with the OP, and returns the user to your web app with verified information ("attributes" or "claims").
Your web application enrolls the user and/or grants access to the protected resource.
If you need an OpenID Connect Provider (OP) to authenticate users, you can use Google or download and deploy the free open source Gluu Server.
Supported OpenID Providers (OP)#
oxd has been confirmed to work with the following OP's:
- Gluu Server
If you have successfully tested oxd against another OP, or for other OP related requests, please email us at firstname.lastname@example.org.
By default, oxd-server is restricted to
localhost, which means its APIs can only be reached by services running locally on the server. oxd-server must be installed on each server that hosts a target application.
Follow these instructions to install and start oxd.
Follow these instructions to configure oxd.
You will need a valid license to properly configure the oxd server. If you have not yet registered for a license, visit the oxd website.
The oxd server supports the OpenID Connect and UMA profiles of OAuth 2.0. OpenID Connect can be used to send a user for authentication and gather identity information about the user. UMA can be used to manage what digital resources the user should have access to.
Learn more in the protocol section
Gluu currently publishes oxd plugins, modules, and extensions for the following open source applications (more coming!):
Note: Gluu does its best to keep these plugins up to date but does not guarantee specific functionality. If you find a bug, or would like feature enhancements, we would be happy to discuss allocating a resource to work on the plugin on a time and materials basis. Schedule a call with us to discuss the project scope and funding.
Gluu offers free community support for oxd on the Gluu Support Portal. You can login to the support site using the same credentials that you use to access the oxd license management app (and vice versa). In fact, we use oxd and a Gluu Server to provide single sign-on across our oxd portal and support app!
If your organization needs guaranteed response times, private support, and priority access to our support and development team, Gluu offers a range of VIP support plans. You can schedule a meeting with us to discuss and move forward with purchasing a support contract.
What is oxd?
oxd is a mediator: it provides API's that can be called by a web application that are easier than directly calling the API's of an OpenID Connect Provider (OP) or an UMA Authorization Server (AS).
Where do I deploy oxd?
oxd is deployed on the same server as the web application(s) you want to protect.
Why should I use oxd?
oxd offers a few key improvements over the traditional model of embedding OAuth 2.0 code in your applications:
If new vulnerabilities are discovered in OAuth2/OpenID Connect, oxd is the only component that needs to be updated. The oxd APIs remain the same, so you don't have to change and regression test your applications;
oxd is written, maintained, and supported by developers who specialize in application security. Because of the complexity of the standards--and the liability associated with poor implementations--it makes sense to rely on professionals who have read the specifications in their entirety and understand how to properly implement the protocols;
Centralization reduces costs. By using oxd across your IT infrastructure for application security (as opposed to a handful of homegrown and third party OAuth2 client implementations), the surface area for vulnerabilities, issue resolution, and support is significantly reduced. Plus you who have someone to call when something goes wrong!
How is oxd licensed?
oxd is commercially licensed. Each time you install oxd you will need to use your license. Active installations are billed $0.33 per day (roughly $10 USD per month per active installation). Get your oxd license today.
Which programming languages and frameworks does oxd have libraries for?
Currently there are oxd libraries for the following languages and frameworks:
How do I get SSO across several websites?
You’ll need two things:
A central OpenID Connect Provider that holds the passwords and user information;
Websites that use the OpenID Connect protocol to authenticate users.
The second is accomplished by installing the oxd service on each web server that needs SSO. This provides easy to use local API’s that can be called by your web applications, and enables you to use a number of plugins for popular open source software packages.
Can I use oxd plugins for social login?
Since oxd simply makes it easy to send users to an OpenID Connect Provider (OP) for login, social login needs to be implemented at the OP. If you are using the Gluu Server, you can use Passport.js to configure and offer social login to your users.
Can I use oxd for two-factor authentication (2FA)?
Again, since oxd simply makes it easy to send users to an OpenID Connect Provider (OP) for login, two-factor authentication needs to be enforced at the OP. If your OP supports two-factor authentication, your application can request it by specifying an
acr_value in the oxd configuration file. To see which types of authentication mechanisms your OP supports navigate to
https://hostname/.well-known/openid-configuration and look for
acr_values. For instance, you can see that Google does not allow a client to request a specific type of authentication: Google OpenID Configuration. The Gluu Server ships with several built in two-factor authentication mechanisms. Two that are very easy to use are FIDO U2F tokens (like Yubikey) and Duo Security. Check out the default acr values for supported authentication mechanisms in the Gluu Server.
Can I use Google or Microsoft Azure Active Directory as my OpenID Connect Provider?
Probably, but Google and Microsoft do not support dynamic client registration. If you are successful with this, please let us know! It should work.
Can I purchase support for the Gluu Server or oxd?
Yes, for information on paid support, visit our website.