-
-
Notifications
You must be signed in to change notification settings - Fork 215
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Pluggable installation of preferences of schema validator (#236)
* Pluggable installation of preferences of schema validator * POC of dynamic import module * Fix npm script for validator installation and integration of javac validator * Integration of libxmljs validator * Add back instruction in README for windows user using libxml as the schema validator * Make the travis test workflow with javac schema validator
- Loading branch information
Showing
9 changed files
with
157 additions
and
50 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -31,4 +31,6 @@ types/ | |
| #vscode | ||
| .vscode | ||
|
|
||
| *.tgz | ||
| *.tgz | ||
|
|
||
| package-lock.json | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,116 @@ | ||
| import * as fs from 'fs'; | ||
| import * as path from 'path'; | ||
|
|
||
| enum SchemaValidators { | ||
| JAVAC = '@passify/xsd-schema-validator', | ||
| LIBXML = 'libxml-xsd' | ||
| } | ||
|
|
||
| interface SchemaValidator { | ||
| validate: (xml: string) => Promise<string>; | ||
| } | ||
|
|
||
| type GetValidatorModuleSpec = () => Promise<SchemaValidator>; | ||
|
|
||
| const moduleResolver = (name: string) => { | ||
| try { | ||
| require.resolve(name); | ||
| return name; | ||
| } catch (e) { | ||
| return null; | ||
| } | ||
| }; | ||
|
|
||
| const getValidatorModule: GetValidatorModuleSpec = async () => { | ||
|
|
||
| const selectedValidator: string = moduleResolver(SchemaValidators.JAVAC) || moduleResolver(SchemaValidators.LIBXML); | ||
|
|
||
| const xsd = 'saml-schema-protocol-2.0.xsd'; | ||
|
|
||
| if (selectedValidator === SchemaValidators.JAVAC) { | ||
|
|
||
| // TODO: refactor | ||
| const setSchemaDir = (v: any) => { | ||
| let schemaDir; | ||
| try { | ||
| schemaDir = path.resolve(__dirname, '../schemas'); | ||
| fs.accessSync(schemaDir, fs.constants.F_OK); | ||
| } catch (err) { | ||
| // for built-from git folder layout | ||
| try { | ||
| schemaDir = path.resolve(__dirname, '../../schemas'); | ||
| fs.accessSync(schemaDir, fs.constants.F_OK); | ||
| } catch (err) { | ||
| //console.warn('Unable to specify schema directory', err); | ||
| // QUESTION should this be swallowed? | ||
| console.error(err); | ||
| throw new Error('ERR_FAILED_FETCH_SCHEMA_FILE'); | ||
| } | ||
| } | ||
| v.cwd = schemaDir; | ||
| v.debug = process.env.NODE_ENV === 'test'; | ||
| return v; | ||
| }; | ||
|
|
||
| const validator = await import (SchemaValidators.JAVAC); | ||
| const mod = setSchemaDir(new validator()); | ||
|
|
||
| return { | ||
| validate: (xml: string) => { | ||
| return new Promise((resolve, reject) => { | ||
| mod.validateXML(xml, xsd, (err, result) => { | ||
| if (err) { | ||
| console.error('[ERROR] validateXML', err); | ||
| return reject('ERR_EXCEPTION_VALIDATE_XML'); | ||
| } | ||
| if (result.valid) { | ||
| return resolve('SUCCESS_VALIDATE_XML'); | ||
| } | ||
| return reject('ERR_INVALID_XML'); | ||
| }); | ||
| }); | ||
| } | ||
| }; | ||
| } | ||
|
|
||
| if (selectedValidator === SchemaValidators.LIBXML) { | ||
| const mod = await import (SchemaValidators.LIBXML); | ||
| return { | ||
| validate: (xml: string) => { | ||
| return new Promise((resolve, reject) => { | ||
| // https://github.com/albanm/node-libxml-xsd/issues/11 | ||
| process.chdir(path.resolve(__dirname, '../schemas')); | ||
| mod.parseFile(path.resolve(xsd), (err, schema) => { | ||
| if (err) { | ||
| console.error('[ERROR] validateXML', err); | ||
| return reject('ERR_INVALID_XML'); | ||
| } | ||
| schema.validate(xml, (techErrors, validationErrors) => { | ||
| if (techErrors !== null || validationErrors !== null) { | ||
| console.error(`this is not a valid saml response with errors: ${validationErrors}`); | ||
| return reject('ERR_EXCEPTION_VALIDATE_XML'); | ||
| } | ||
| return resolve('SUCCESS_VALIDATE_XML'); | ||
| }); | ||
| }); | ||
| }); | ||
| } | ||
| }; | ||
| } | ||
|
|
||
| // allow to skip the validate function if it's in development or test mode if no schema validator is provided | ||
| if (process.env.NODE_ENV === 'dev' || process.env.NODE_ENV === 'test') { | ||
| return { | ||
| validate: (_xml: string) => { | ||
| return new Promise((resolve, _reject) => resolve('SKIP_XML_VALIDATION')); | ||
| } | ||
| }; | ||
| } | ||
|
|
||
| throw new Error('ERR_UNDEFINED_SCHEMA_VALIDATOR_MODULE'); | ||
|
|
||
| }; | ||
|
|
||
| export { | ||
| getValidatorModule | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters