View source for PasswordVerify

<!-- This page is generated automatically from the function definition: passwordVerify. -->
= passwordVerify =
Queues an asynchronous Argon2id password verification operation.

== Syntax ==
<syntaxhighlight lang="lua">
number|false passwordVerify(string password, string encodedHash, function callback)
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>password</code> || <code>string</code> || yes || The password candidate, from 1 to 256 bytes.
|-
| <code>encodedHash</code> || <code>string</code> || yes || A valid encoded Argon2id hash previously produced by <code>passwordHash</code>.
|-
| <code>callback</code> || <code>function</code> || yes || Called as <code>callback(success, matches, error)</code>.
|}

== Returns ==
Returns a numeric request identifier when queued, or <code>false</code> when validation, service availability, or queue limits reject the request.

== Examples ==
Verify an account password:
<syntaxhighlight lang="lua" line>
passwordVerify(password, account.passwordHash, function(success, matches, errorMessage)
    if success and matches then
        outputDebugString("Password accepted")
    elseif errorMessage then
        outputDebugString(errorMessage)
    end
end)
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* A successful request can still report <code>matches = false</code> for an incorrect password.
* Verification runs on the bounded password worker service and does not block the server tick.

[[Category:Lua Functions]]
[[Category:Server Functions]]
[[Category:Utility Functions]]