WARNING: This server provides a static reference view of the NetKernel documentation. Links to dynamic content do not work. For the best experience we recommend you install NetKernel and view the documentation in the live system .

Endpoint
Name:CheckPasswordHash
Description:Check a Password Hash
Id:CheckPasswordHash
Category:accessor
Identifier Syntax

CheckPasswordHash is an accessor using Active URI syntax with the following base identifiers:

Base
active:checkPasswordHash

and the following arguments: (for more details on argument passing details see here)

ArgumentRulesTypingDescription
password
Mandatory
Representation (java.lang.String)password to generate hash for
hash
Mandatory
Representation (java.lang.String)stored hash to check password against
algorithm
Optional
Defaults to "sha512"
Representation (java.lang.String)hash algorithm to use, defaults to sha512
Request Verbs

The following verb is supported:

Verb
SOURCE
Response

The following response representations can be returned for SOURCE requests:

SOURCE Representations
java.lang.Booleanjava.lang.String

This accessor throws no documented exceptions.

Import Requirements

To use CheckPasswordHash accessor you must import the module urn:org:netkernel:mod:security:

<import>
  <uri>urn:org:netkernel:mod:security</uri>
</import>

This endpoint is designed as a pair with generatePasswordHash to provide a method of storing passwords safely not in their plain-text form.

This endpoint uses a pre-generated hash strengthened with a random salt to test against the supplied password. If the hashes match this endpoint will return boolean true.

The optional algorithm argument, if specified, must be one of the active identifier types from the Crypto Checksum accessor. e.g. md5, sha256.