Newts Parading Majestically

    ltpa
    TypeScript icon, indicating that this package has built-in type declarations

    1.2.1 • Public • Published

    ltpa

    travis build codecov coverage version license

    A small library for generating and validating ltpa tokens. Based on the IBM specification.

    Who is this for?

    For developers integrating Node.js applications with the world of IBM Domino and/or Websphere.

    Retrieving the server secret

    In IBM Domino, the server secret can be found in the names.nsf database, ($WebSSOConfigs) view, LTPA_DominoSecret field.

    Getting the module

    $ npm install ltpa

    or clone it from github:

    $ git clone https://github.com/markusberg/ltpa.git

    API

    This is the full API, but normally you'll only use a few of these methods. See examples below.

    • setSecrets(secrets: Secrets): Add your server secrets to the library, for later use in validation and signing of tokens
    • refresh(token: string, domain: string): Validate provided token, and return a fresh token
    • generateUserNameBuf(userName: string): Generate a userName Buffer. Currently hardcoded to CP-850, but the true char encoding is LMBCS
    • generate(userNameBuf: Buffer, domain: string): Generate a Base64-encoded Ltpa token
    • setValidity(seconds: number): Set how long a generated token is valid. Default is 5400 seconds (90 minutes).
    • setStrictExpirationValidation(strict: boolean): If set to true, token expiration validation will check the actual validation timestamp in the token instead of the calculated expiration. See the "Known Issues" section below.
    • setGracePeriod(seconds: number): Set the amount of time outside a ticket's validity that we will still accept it. This time is also added to the validity of tokens that are generated. Default is 300 seconds (5 minutes).
      NOTE: since the grace period is added both on token generation, and during validation, the actual grace period is double what is set here.
    • getUserName(token: string): Retrieve the username as a string from the provided token. No validation of the token is performed
    • getUserNameBuf(token: string): Retrieve the username as a Buffer from the provided token. No validation of the token is performed
    • validate(token: string, domain: string): Validate provided token. Throws an error if validation fails

    Example 1

    These examples are for Express, but the functionality should be easy to adapt to Koa or other frameworks.

    Add the dependency and create a simple middleware:

    let ltpa = require("ltpa")
    ltpa.setSecrets({
      "example.com": "AAECAwQFBgcICQoLDA0ODxAREhM=",
    })
     
    /***
     * Express Middleware
     * Authenticate user by verifying the provided LtpaToken cookie
     */
    function mwLtpaAuth(req, res, next) {
      try {
        let ltpaToken = ltpa.refresh(req.cookies.LtpaToken, "example.com")
        let newCookie =
          "LtpaToken=" + ltpaToken + "; Path=/; Domain=" + "example.com"
        res.setHeader("Set-Cookie", newCookie)
        next()
      } catch (err) {
        console.log(err)
        res.status(401).json({ message: "Not authorized for this resource" })
      }
    }
     
    /***
     * Express route
     */
    router.get("/testAuth", mwLtpaAuth, function (req, res) {
      res.send("user is logged in as " + ltpa.getUserName(req.cookies.LtpaToken))
    })

    Example 2

    If you need to access a backend Domino database using a specific user account, you can generate an LtpaToken for that account using the generate method:

    let ltpa = require("ltpa")
    let rp = require("request-promise")
     
    ltpa.setSecrets({
      "example.com": "AAECAwQFBgcICQoLDA0ODxAREhM=",
    })
     
    router.get("/myDominoView", function (req, res) {
      let userNameBuf = ltpa.generateUserNameBuf("Sysadmin Account")
      let backendToken = ltpa.generate(userNameBuf, "example.com")
     
      let dominoRequest = {
        uri: "https://domino.example.com/api/data/collections/name/myDominoView",
        method: "GET",
        strictSSL: true,
        timeout: 30000,
        headers: {
          Cookie: "LtpaToken=" + backendToken,
        },
      }
     
      rp(dominoRequest)
        .then((response) => res.json(response))
        .catch((err) => {
          console.log(err)
          res.status(500).send(err)
        })
    })

    Tests

    $ npm test

    or to run it continuously, while watching for changes

    $ npm run test:watch

    Known issues

    Token validity

    When validating token expiration, the library will only respect its internal validity setting, and will disregard the expiration-date setting in provided tokens. To force the library to use the actual timestamp in the token, use the setStrictExpirationValidation() method. This behaviour might change in version 2.

    Character set

    The module only works with usernames containing characters in the ibm850 codepage (basically Latin-1). The username in the token should be encoded in an IBM proprietary format called LMBCS (Lotus Multi-Byte Character Set) for which I have found no javascript implementation. However, LMBCS is backwards compatible with ibm850 for all characters in that codepage so if your usernames don't contain characters outside of ibm850, then you're good to go.

    LTPA1 only

    The package only supports LTPA1, and not LTPA2. WebSphere Application Server Version 5 and later supports LTPA1. WebSphere Application Server Version 7 and later supports LTPA2:

    https://www.ibm.com/support/knowledgecenter/en/SSAW57_8.5.5/com.ibm.websphere.nd.doc/ae/cwbs_ltpatokens.html

    However, there is a package by Benjamin Kröger for dealing with LTPA2:

    Install

    npm i ltpa

    DownloadsWeekly Downloads

    37

    Version

    1.2.1

    License

    Apache-2.0

    Unpacked Size

    40.6 kB

    Total Files

    9

    Last publish

    Collaborators

    • markusberg