Uploaded image for project: 'Apache Knox'
  1. Apache Knox
  2. KNOX-3010

User Guide Docs for Token Management typos

    XMLWordPrintableJSON

Details

    • Bug
    • Status: Open
    • Major
    • Resolution: Unresolved
    • None
    • None
    • Document
    • None

    Description

      The following docs are incorrect and need some correction:

      h5. Creating the token hash key [!https://knox.apache.org/books/knox-2-1-0/markbook-section-link.png!|https://knox.apache.org/books/knox-2-1-0/user-guide.html#Creating+the+token+hash+key]
      
      As explained, if you would like to use Knox’s token generation features, you will have to create a gateway-level alias with a 256, 384, or 512-bit length JWK. You can do it in - at least - two different ways:
       # You generate your own MAC (using [this online tool|https://8gwifi.org/jwkfunctions.jsp] for instance) and save it as an alias using Knox CLI.
       # You do it running the following Knox CLI command:
      {{generate-jwk --saveAlias knox.token.hash.key}}
      
      The second option involves a newly created Knox CLI command called {{{}generate-jwk{}}}:
      h5. Token state service implementations [!https://knox.apache.org/books/knox-2-1-0/markbook-section-link.png!|https://knox.apache.org/books/knox-2-1-0/user-guide.html#Token+state+service+implementations]
      
      

      I assume the command example that starts with generate-jwk should be knoxcli.sh and the example command for generate-jwk should be after the mention of the second option.

      Attachments

        Activity

          People

            Unassigned Unassigned
            lmccay Larry McCay
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated: