This is a development toolkit for customizing your AM authentication tree, device match node. The purpose of this project is to help you develop complex scripts in modern JavaScript with modular architecture. You also have the availability of the NPM ecosystem to help speed up development.
There are a few things to note:
dist/script.js and pasting its contents into the Device Match node in AMdist/src/ directory and can be as modular as one desiressrc/index.jstest/ directory along with sample device profilesAfter cloning this repo locally, install the needed dependencies and build the project:
npm install
npm run build
The build command will test the source code, "compile" and bundle the output, and then run a test on the final script.
dist/script.js and paste it into your Device Match node in AM; This will incorporate both metadata and location match with defaultssrc/index.js to use the metadata match without the location match or vice versasrc/index.jssrc/metadata.js and src/location.js, respectively)This script uses recursive iteration to compare the two metadata objects. It is written with small to moderately large sized JavaScript objects in mind, and is not optimized for very large or very deep structures.
When the recursion meets a primitive value (string, number, boolean, etc), it does a comparison of values. If there's a mismatch, it will increment the number of mismatches. There are two ways to configure this algorithm:
maxUnmatchedAttrs)attrWeights)To expand on #2, let's say you have a maximum number of mismatches set to 2. This could be exceeded by having three attributes with the default weight of 1 not match (n=1+1+1), or you could have 1 property with a weight of 3 not match (n=3).
Why would you do this? Well, certain profile properties, like display width or height, will vary if the user changes displays from the prior authentication. If you're less concerned with the display properties, because they can easily change (e.g. extending your laptop's display), and more concerned with things that will remained unchanged, like the device's memory, you can weigh them appropriately.
This script doesn't internally compare geolocation coordinates. We are using an external library called geolib, which is well built and very powerful. getDistance is the only function used out of the library, and all we do is wrap it with a comparison of the distance between two points to that of the maximum allowed radius (all units in meters). This radius can be configured (allowedRadius).
// Run without configuration
const [ metadataMatch, locationMatch ] = deviceMatcher();
const isMetadataMatching = metadataMatch(a, b);
const isLocationMatching = locationMatch(a, b);
// Run without location match
const [ metadataMatch ] = deviceMatcher();
const isMetadataMatching = metadataMatch(a, b);
// Or, with just location match
const [ _, locationMatch ] = deviceMatcher();
const isLocationMatching = locationMatch(a, b);
// Run with configuration
// (all properties are optional)
const config = {
allowedRadius: 250, // type `number`; defaults to 100 (meters)
attrWeights: {
// Custom weights for metadata attributes (object keys)
deviceMemory: 3 // type `number`
// ... as many attributes as you want
// all attributes default to 1
},
maxUnmatchedAttrs: 2, // type `number`; default to 0 (exact match)
};
const [ metadataMatch, locationMatch ] = deviceMatcher(config);
const isMetadataMatching = metadataMatch(a, b);
const isLocationMatching = locationMatch(a, b); Using the Development Toolkit
After finalizing your changes, you can build the unified script with the below command:
This will test the source code, "compile" and bundle the output, and then run a test on the final script. You can find this output script within the dist/ directory. This script is what you'll copy and paste into AM's script editor for the Device Match node.
For convenience, you can also run a watch command, and it will watch for source file changes and test your code and build the output upon changes:
Rollup is the library used for the bundling. You can find more information on it here: http://rollupjs.org.
Babel is the library used to transpile your modern JavaScript down to the appropriate version for Rhino (JS runtime used in AM). You can find more about Babel here: https://babeljs.io/. As-is, this build step will not support the new, native Object/Array/String methods without a polyfill [FAQ: 1].
You can run tests on the source code as well as a test for the final script:
# Test source code
npm run test
# Test bundled script
npm run test:bundle
(You may notice a test.config.js in the root of the project. This is only used for testing the bundled script (not the source code), so it can inject the appropriate globals that the script expects.)
Jest is the test framework used. You can find more information about it here: https://jestjs.io.
For this sample script, we didn't see enough need for the new, native Object/Array/String methods to offset the cost of the additional code output. So, we didn't include the polyfills. But, if you see the need for them, you can easily add them by following these instructions: https://babeljs.io/docs/en/babel-polyfill.
If you encounter any issues, be sure to check our Troubleshooting pages.
Support tickets can be raised whenever you need our assistance; here are some examples of when it is appropriate to open a ticket (but not limited to):
You can raise a ticket using BackStage, our customer support portal that provides one stop access to ForgeRock services.
BackStage shows all currently open support tickets and allows you to raise a new one by clicking New Ticket.
Our version history can be viewed by visiting our CHANGELOG.md.
If you would like to contribute to this project you can fork the repository, clone it to your machine and get started.
Be sure to check out our Coding Style and Guidelines page.
This code is provided by ForgeRock on an “as is” basis, without warranty of any kind, to the fullest extent permitted by law. ForgeRock does not represent or warrant or make any guarantee regarding the use of this code or the accuracy, timeliness or completeness of any data or information relating to this code, and ForgeRock hereby disclaims all warranties whether express, or implied or statutory, including without limitation the implied warranties of merchantability, fitness for a particular purpose, and any warranty of non-infringement. ForgeRock shall not have any liability arising out of or related to any use, implementation or configuration of this code, including but not limited to use for any commercial purpose. Any action or suit relating to the use of the code may be brought only in the courts of a jurisdiction wherein ForgeRock resides or in which ForgeRock conducts its primary business, and under the laws of that jurisdiction excluding its conflict-of-law provisions.
This project is licensed under the MIT License - see the LICENSE file for details
© Copyright 2020 ForgeRock AS. All Rights Reserved.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4