API.md

API

authorize()

• Gets signKey from req.__signKey.
• Generates hash from given parameters and signKey.
• Compares generated hash with one from headers.authorization.
• Might call next() with the ServiceAuthError error. Possible error messages:
  • The 'signKey' is not found.
  • Invalid authorization key.

   const AuthService = require('service-auth')

   router.post('/',
     // ... middleware to get signKey and set on req.__signKey
     AuthService.authorize,
    
     // ... more middlewares
     // handler
   )

setAuthorization(...)

• Sets authorization.
• Sets nonce, clientid, timestamp, authorization headers.
• New options object is returned.

   const AuthService = require('service-auth')
 
   const initialOptions = {
      uri: 
      // ... lot more
      
      headers: {  // optional, defaults to {}  
        ...  
      }
   }
   const finalOptions = AuthService.setAuthorization(initialOptions, signKey, clientId),