Security News
Research
Data Theft Repackaged: A Case Study in Malicious Wrapper Packages on npm
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
# Use via the CLI
npm install -g asl-puml
# Use in your code
npm install asl-puml
$ asl-puml --help
Usage: asl-puml [options]
Amazon States Language to PUML
Options:
Amazon States Language to PUML
Options:
-i --input <input> path to input file
-o --output <output> path to output dir
-c --config <config> path to config file
-h, --help display help for command
Return status:
0
if diagram was generated1
if there was an errorconst aslPuml = require('asl-puml');
const definition = require('./path/to/my/state/machine/json/definition');
const { isValid, puml, message } = aslPuml(definition);
if (isValid) {
console.log(puml)
} else {
console.error(message);
}
Generates a plantuml state diagram from a valid Amazon States Language file.
The existing tools are good, but I'm looking for a simpler rendering that encodes a little more info than the AWS Toolkit.
I also do all of my development in an IDE and don't want to switch to the browser based AWS Workflow Studio.
See __tests__/Definitions/demo.asl.json
for the step function used for these examples.
The diagrams below show the same step function rendered by:
Feature or Style Requirement | asl-puml | AWS Toolkit | AWS Workflow Studio |
---|---|---|---|
renders the step function as a state diagram | |||
conveys the behavior for the state | :white_check_mark:, via colors and some icons | :x: | :white_check_mark:, very familiar AWS icons and colors. |
matches the style for instance executions | :x: | :white_check_mark: | :x: |
renders within Webstorm/JetBrains products | :white_check_mark:, via the existing plantuml plugin | :x:, not in AWS Toolkit for Webstorm | :x: |
renders the step function within VS Code | :white_check_mark:, via the existing plantuml plugin | :white_check_mark:, available in AWS Toolkit for VS Code | :x: |
label the path from a catch | :white_check_mark:, with line weight and color | :x: | :white_check_mark:, path is labeled with a Catch |
label the path to a Fail state | :white_check_mark:, with line weight and color | :x: | :x: |
identify the compensation path | :white_check_mark:, albeit hard coded by state name regex | :x: | :x: |
avoid drawing duplicate paths to reduce clutter (catches) | :white_check_mark: | :white_check_mark: | :x:, all paths are drawn |
The term "compensate" is borrowed from business processes where it refers to the undoing of work as part of handling a fault.
When reviewing a process, it's useful to identify which parts of the process are in service of the happy path versus those in the compensation path.
Currently, the library uses a regex to match on the state's name to decide if it's in the compensation path. This will be made configurable as part of the theme. There isn't a good way to determine the compensation path without hints from the config.
A user supplied file that conforms to the config-schema.json type can be provided to control the diagram theme.
{
"theme": {
"skinparams": {
"ArrowColor": "#black"
},
"states": {
"Pass": {
"BackgroundColor": "#whitesmoke"
},
"Map": {
"BackgroundColor": "#whitesmoke"
},
"Choice": {
"BackgroundColor": "#whitesmoke"
},
"Parallel": {
"BackgroundColor": "#whitesmoke"
},
"Wait": {
"BackgroundColor": "#whitesmoke"
},
"Task": {
"BackgroundColor": "#lightblue"
},
"Fail": {
"BackgroundColor": "#red"
},
"Succeed": {
"BackgroundColor": "#green"
}
},
"lines": {
"fromCatch": {
"bold": true,
"color": "#orange"
},
"toFail": {
"color": "#pink"
}
},
"compensation": {
"pattern": "^.*(compensate).*$",
"color": "#orange"
}
}
}
See LICENSE.
FAQs
Generates a plant uml file from a valid JSON ASL file
We found that asl-puml demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.