libubsub provides a common set of functionality to connect and consume ubsub's API and pub/sub events.
Its primary goals are to simplify:
- Making API calls to ubsub
- Consuming events and validating events
- Validating signatures
- Simplifying complex systems (SocketIO) and wrapping in ubsub terminology
npm install --save libubsubTo see a complete list of functions, please see DOCUMENTATION.md
The express middleware inspects the signature that comes in on the router via X-Router-Signature, and denies
the request if it's not a wholly valid signature (Expiration, app domain, source, etc..)
const { middleware } = require('libubsub');
// express stuff..
app.use(middleware.validateSignature('my.domain'));Once the signature has been validated, it is then safe to parse and validate the request body. The initial step won't validate the body for you, for two reasons: 1) We don't want to assume that there is a body, and 2) we don't want to have to parse the body before we know if it comes from a safe place.
To validate the body, validateSignatureHash must be called after any body-parsing and validateSignature, as
it expects req.body and req.routerSignature to be populated.
app.use(middleware.validateSignature('example.com'));
app.use(bodyParser.json());
app.use(middleware.validateBodyHash());If you wish to use the signature validation directly, you can use the signature class.
The signature class should do a good job retrieving and pre-fetching the public key from the router. By default,
this happens every 15 minutes (see: config.js).
You can also read more about the JWT signature in the ubsub docs.
const { Signature } = require('libubsub');
const signatureValidator = new Signature();
// Returns promise that was either rejected or resolved depending on validity
// If resolved, contains the JWT object
signatureValidator.assertValidJwt(tokenString);We also bundle a client API wrapper for the router built on top of axios.
const { api } = require('libubsub');
const userId = '...';
const userKey = '...';
const client = api(userId, userKey);
client.getUser();You can see the full list of functions in api.js
Copyright (c) 2019 Christopher LaPointe
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.