[ 
https://issues.apache.org/jira/browse/KNOX-3010?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Larry McCay updated KNOX-3010:
------------------------------
    Description: 
The following docs are incorrect and need some correction:

{code}
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]

{code}

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.



  was:
The following docs are incorrect and need some correction:

{code}
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]

{code}

I assume the comman 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.




> User Guide Docs for Token Management typos
> ------------------------------------------
>
>                 Key: KNOX-3010
>                 URL: https://issues.apache.org/jira/browse/KNOX-3010
>             Project: Apache Knox
>          Issue Type: Bug
>          Components: Document
>            Reporter: Larry McCay
>            Priority: Major
>
> The following docs are incorrect and need some correction:
> {code}
> 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]
> {code}
> 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.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

Reply via email to