This module provide an useful helper to use the authentication service in EC.

Compatibility

The minimum supported version of Node.js is v8.

How to use it

To use the library you just need to follow the following steps Install the library with npm

npm install @condor-labs/auth-ec

Import the library:

const auth = require('@condor-labs/auth-ec')(settings);

settings object properties

| Property | Default | Description | |-----------|-----------|-------------| | authBaseURL (url) | null | This URL correspond to the Auth service. | | cacheTTLSecsForBasicToken (number) | null | Time in secs to keep cache for BasicToken (apikey) validation. Default: 24 Hrs | | cacheTTLSecsForSessionToken (number) | null | Time in secs to keep cache for SessionToken validation. Default: 60 Secs | | redisSettings*(Object)* | null | Check this settings for details |

Examples

constants.js

module.exports = {
    settings: {
        appName: 'EXAMPLE_APP',
        authBaseURL: 'https://auth.ec.com',
        redisSettings:{
            host: 'redis.cloud.redislabs.com',
            port: 17005,
            password: '****'
        }
    }
};

index.js

const {
    settings
} = require('./constants');

try {
    (async () => {
        const auth = require('./../library')(settings);
        console.log('settings OK')
        console.log('==================================')
        let res = await auth.validateSessionToken({
            token:'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9xxxxxx'
        });
        console.log('auth.validateSessionToken() #1', res);
        console.log('==================================')
        let res2 = await auth.validateBasicToken({
            token: 'NzYyOWJhZjItMzgwMS00Yxxxxxx==', 
            authUsername: 'bc95d8fe-eb6d-4e7a-xxxxxx', 
            authPassword: 'Kiv6BBXLOsTAV8vI/nRxxxxxx', 
            applicationURL: 'https://xxxxxx.test.evercheck.com'
        });
        console.log('auth.validateBasicToken() #1', res2);
        // close app
        process.exit(1);
    })();
} catch (error) {
    console.error('settings ERROR',error)
}

How to Publish

Increasing package version

You will need to update the package.json file placed in the root folder.

identify the property version and increase the right number in plus one.

Login in NPM by console.

 npm login
 [Enter username]
 [Enter password]
 [Enter email]

If all is ok the console will show you something like this : Logged in as USERNAME on https://registry.npmjs.org/.

Uploading a new version

 npm publish --access public

Ref: https://docs.npmjs.com/getting-started/publishing-npm-packages

Note: you will need to have a NPM account, if you don't have one create one here: https://www.npmjs.com/signup

Contributors

The original author and current lead maintainer of this module is the @condor-labs development team.

More about Condorlabs Here.

License

MIT