{authmosphere} is a library to support OAuth2 workflows in JavaScript projects.
It's implemented in TypeScript which improves the development experience via implicit documentation with types, first-class IDE support and provides mock tooling for local development. The library itself is transpiled to JavaScript (ES6) so there is no need for a TypeScript compiler to use authmosphere in JavaScript projects.
Currently the following flows are supported:
- Authorization Code Flow
- Client Credentials Grant
- Resource Owner Password Credentials Grant
- Refresh Token Grant
- Express middlewares to simplify authentication/authorization
TokenCacheservice to manage access tokens in your application
See STUPS documentation and OAuth2 documentation for more information.
The project was renamed from lib-oauth-tooling to authmosphere. In the course of this renaming versioning was restarted at 0.1.0. Version 1.0.0 is soon to be released, keep track of the progess in #92, this release will contain breaking changes.
Migrate from [email protected]. to [email protected]
- call
npm uninstall --save lib-oauth-tooling - call
npm install --save authmosphere
The signature of the function createAuthCodeRequestUri was changed to be better suitable for partial application. The authorizationEndpoint parameter was moved to the first position.
It's important to manually adjust your code to this change, since the type system is not helpful in this special case.
function createAuthCodeRequestUri(authorizationEndpoint: string,
redirectUri: string,
clientId: string,
queryParams?: {}): stringMigrating from [email protected]. to [email protected]
If you depend on the realm property you now have to pass the value via the queryParams parameters in OAuthConfig:
// will NOT work anymore:
getAccessToken({
// all the other config
// ...
realm: EMPLOYEES_REALM,
})
.then(token: Token => {
// ...
});
// instead use this:
getAccessToken({
// all the other config
// ...
queryParams: { realm: '/employees' }
})
.then(token: Token => {
// ...
});See the changelog for more information.
Note: node >= 6.0.0 required to consume this library.
Run npm install authmosphere.
Import a member of this lib like so (of course ES5 syntax is working as well...):
import {
TokenCache,
handleOAuthRequestMiddleware,
requireScopesMiddleware,
...
} from 'authmosphere';TokenCache(tokenConfig: { [key: string]: string[] }, oAuthConfig: OAuthConfig, tokenCacheConfig?: TokenCacheConfig)
Class to request and cache tokens on client-side.
const tokenCache = new TokenCache({
'service-foo': ['foo.read', 'foo.write'],
'service-bar': ['bar.read']
}, oAuthConfig);
tokenCache.get('service-foo')
.then((token: Token) => {
console.log(token.access_token);
});Where OAuthConfig is defined like:
type OAuthConfig = {
credentialsDir: string;
grantType: string;
accessTokenEndpoint: string;
tokenInfoEndpoint?: string; // mandatory for TokenCache
scopes?: string[];
redirect_uri?: string; // (required with `AUTHORIZATION_CODE_GRANT`)
code?: string; // (required with `AUTHORIZATION_CODE_GRANT`)
redirectUri?: string;
refreshToken?: string;
queryParams?: {};
};Valid grantTypess are:
'authorization_code''password''client_credentials''refresh_token'
You can also import the constants from the lib:
import {
AUTHORIZATION_CODE_GRANT,
PASSWORD_CREDENTIALS_GRANT,
CLIENT_CREDENTIALS_GRANT,
REFRESH_TOKEN_GRANT
} from 'authmosphere';Optionally, you can pass a third parameter of type TokenCacheConfig to the TokenCache constructor to configure the cache behaviour.
const tokenCache = new TokenCache({
'service-foo': ['foo.read', 'foo.write'],
'service-bar': ['bar.read']
}, oAuthConfig, cacheConfig);WhereTokenCacheConfig is defined like:
type TokenCacheConfig = {
/**
* To determine when a token is expired locally (means
* when to issue a new token): if the token exists for
* ((1 - percentageLeft) * lifetime) then issue a new one.
* Default value: 0.75
*/
percentageLeft: number
};Express middleware to extract and validate an access token. It attaches the scopes matched by the token to the request (request.scopes) for further usage.
If the token is not valid the request is rejected (with 401 Unauthorized).
app.use(handleOAuthRequestMiddleware({
publicEndpoints: ['/heartbeat', '/status'],
tokenInfoEndpoint: 'auth.example.com/tokeninfo'
});options:
publicEndpointsstring[]tokenInfoEndpointstring
Specifies the scopes needed to access an endpoint. Assumes that there is an request.scopes property (as attached by handleOAuthRequestMiddleware) to match the required scopes against.
If the the requested scopes are not matched request is rejected (with 403 Forbidden).
app.get('/secured/route', requireScopesMiddleware(['scopeA', 'scopeB']), (request, response) => {
// do your work...
})Makes a request to the tokenInfoEndpoint to validate the given accessToken.
getTokenInfo(tokenInfoEndpoint, accessToken)
.then((token: Token) => {
console.log(token.access_token);
})
.catch((err) => {
console.log(err);
});Type Token is defined as following:
type Token<CustomTokenPart = any> = CustomTokenPart & {
access_token: string;
expires_in?: number;
scope?: string[];
token_type?: string;
local_expiry?: number;
};The Token type is designed to be extensible. By default the generic type parameter CustomTokenPart defaults to any. One can provide an additional type to extend the known properties for the Token type:
type CustomDataType = {
uid: "user",
...
};
const myCustomToken: Token<CustomDataType> = {
...
};Helper function to get an access token for the specified scopes.
getAccessToken(options)
.then((token: Token) => {
console.log(token.access_token);
})
.catch((err) => {
console.log(err);
});String constant specifying the Authorization Code Grant type.
String constant specifying the Resource Owner Password Credentials Grant type.
String constant specifying the Refresh Token Grant type.
If you want to test oAuth locally without being able to actually call real endpoints this library provides some tooling.
Mocks a tokeninfo endpoint.
mockTokeninfoEndpoint({
url: 'http://some.oauth.endpoint/tokeninfo',
tokens: [{
access_token: 'someToken123',
scope: ['uid', 'something.read', 'something.write']
}],
times: 1
});options:
urlstring (url of thetokeninfoendpoint)tokensany optional (list of valid tokens)timesnumber optional (for how many times/calls the endpoint is mocked, default isNumber.MAX_SAFE_INTEGER)
Mocks a access_token endpoint.
mockAccessTokenEndpoint({
url: 'http://some.oauth.endpoint/access_token',
times: 1
});options:
urlstring (url of theaccess_tokenendpoint)timesnumber optional (for how many times/calls the endpoint is mocked, default isNumber.MAX_SAFE_INTEGER)
Cleans all nock mocks (not only from this lib, really ALL) and given tokens.
Helpful when having multiple tests in a test suite, you can call cleanMock() in the afterEach() callback for example.
cleanMock();- clone this repo
npm install- to build:
npm run build - to lint:
npm run tslint
npm test- runs all testsnpm run unit-test- runs unit testsnpm run integration-test- runs integration tests
Modified signature of createAuthCodeRequestUri, see migration guide for more information.
The (zalando-specific) realm property was removed from OAuthConfig. Also, the corresponding constants (SERVICES_REALM and EMPLYEES_REALM) were removed. Instead, you can add the realm (and arbitrary other query parameters) via the queryParams property in OAuthConfig.
The signature of requireScopesMiddleware is now incompatible with previous versions, precedenceFunction? is now part of precedenceOptions?.
MIT License (MIT)
Copyright (c) 2016 Zalando SE
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.