Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 123x 123x 123x 123x 13x 13x 13x 13x 13x 110x 110x 123x 9x 9x 9x 9x 9x 101x 101x 123x 3x 3x 3x 3x 3x 98x 98x 98x 98x 98x 98x 98x 98x 123x 67x 67x 54x 54x 54x 67x 98x 123x 38x 38x 29x 29x 29x 38x 98x 98x 1x | /*!
* Copyright (c) 2026 The Triauth Authors (https://www.triauth.org/)
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* SPDX-License-Identifier: Apache-2.0
*/
/**
* Methods related to validation of various objects related to the triauth protocol
*
* @namespace Validation
* @memberof Triauth.Api
*/
import { KNOWN_CONFIG_KEYS } from '../config.js';
import { Helpers } from '../helpers.js';
import { Validator } from '../validator.js';
/**
* The validate method can be used to perform a basic format validation on the given objects.
* It is fast, synchronous, and does not perform any DNS requests.
*
* Currently, it supports validation of personal identifiers (`identifier`) and device names (`deviceName`).
* At least one of the supported objects must be provided, and unrecognized (e.g., misspelled)
* keys are rejected, so that nothing silently passes as valid without being validated.
*
* Synopsis:
*
* ```javascript
* let validationResult = Triauth.validate({identifier?, deviceName?});
* // returns {valid:true, errors:[]} if all the objects passed validation
* // returns {valid:false, errors:[{code:..., message:...}, ...]} if at least one the objects failed validation
* // returns {valid:false, errors:[{code:101, ...}]} when objects is empty or not an object
* // returns {valid:false, errors:[{code:102, ...}]} when objects contains an unrecognized key or an undefined value
* // returns {valid:false, errors:[{code:103, ...}]} when config contains an unrecognized key or a key set to undefined
*
* ```
*
* Example:
*
* ```javascript
* Triauth.validate({identifier: 'john@triauthdemo.org'});
* // {valid: true, errors: []}
*
* Triauth.validate({identifier: 'john'});
* // {valid: false, errors: [{code: 214, message: 'Identifier must include one @ sign'}]}
* ```
*
* > [!NOTE]
* > `{valid: true}` confirms the *format* only - it is not input sanitization.
* > Callers must still encode or escape the value for whatever sink it flows into (SQL, shell, file paths, HTML, log lines).
*
* @param objects {object} - one or more objects to validate
* @param [objects.identifier] {string} - an identifier to validate
* @param [objects.deviceName] {string} - a deviceName to validate
* @param [config={}] {object} - optional overrides for the global Triauth.config settings; unrecognized keys are rejected (103)
*
* @returns {{valid: boolean, errors: Array<{code: number, message: string}>}}
* An object with valid property containing the validation result,
* and the errors property containing an array of errors (if any),
* in the {code: number, message: string} format.
*/
export const validate = function(objects, config = {}) {
// `objects` must be a plain object with at least one supported entry,
// so that e.g. validate(null) or validate({}) cannot pass as valid.
if (!objects || typeof objects !== 'object' || Array.isArray(objects) || Object.keys(objects).length === 0) {
return {
valid: false,
errors: [{code: 101, message: 'Invalid or missing function arguments'}]
};
}
// Ensure only recognized objects with defined values are present to help avoid misspellings.
if (!Helpers.hasOnlyKnownProperties(objects, ['identifier', 'deviceName'])) {
return {
valid: false,
errors: [{code: 102, message: 'Unrecognized function argument'}]
};
}
// Reject config overrides carrying unknown keys
if (!Helpers.hasOnlyKnownProperties(Helpers.mergeConfig(config), KNOWN_CONFIG_KEYS)) {
return {
valid: false,
errors: [{code: 103, message: 'Unrecognized configuration override'}]
};
}
const retval = {
valid: true,
errors: []
};
const keys = Object.keys(objects);
if (keys.indexOf('identifier') >= 0){
let vr = Validator.validateIdentifier(objects['identifier']);
if (!vr.valid) {
retval.valid = false;
retval.errors = retval.errors.concat(vr.errors);
}
}
if (keys.indexOf('deviceName') >= 0){
let vr = Validator.validateDeviceName(objects['deviceName']);
if (!vr.valid) {
retval.valid = false;
retval.errors = retval.errors.concat(vr.errors);
}
}
return retval;
};
|