Skip to content

Commit 9fcd82c

Browse files
ziaghamziagham
committed
Update README file
#5
1 parent 434581f commit 9fcd82c

File tree

2 files changed

+156
-52
lines changed

2 files changed

+156
-52
lines changed

‎README.md‎

Lines changed: 78 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,94 @@
1-
# FlowSynx SHA Hash Plugin – FlowSynx Platform Integration
1+
# FlowSynx SHA Hashing Plugin
22

3-
The SHA Hash Plugin is a secure, plug-and-play component for the FlowSynx engine. It enables the computation of various SHA family hashes (including SHA-1, SHA-2, SHA-3, and SHAKE) from text or binary data, and is designed to seamlessly integrate into FlowSynx’s no-code/low-code automation workflows.
3+
The **SHA Hashing Plugin** is a pre-packaged, plug-and-play integration component for the FlowSynx engine. It provides a wide range of secure hashing algorithms, including SHA-1, SHA-2, SHA-3, and SHAKE variants, enabling workflows to compute cryptographic hashes of input data. This plugin supports both text and binary data and allows configurable output lengths for extendable-output functions (XOF) like SHAKE128 and SHAKE256.
44

5-
This plugin is automatically installed and managed by the FlowSynx engine when selected within the platform. It is not intended for standalone use or manual installation outside the FlowSynx environment.
5+
This plugin is automatically installed by the FlowSynx engine when selected within the platform. It is not intended for manual installation or standalone developer use outside the FlowSynx environment.
66

77
---
88

99
## Purpose
1010

11-
This plugin allows FlowSynx users to generate cryptographic hash values using a range of SHA algorithms for input values as part of their workflow logic—without writing any code. Once activated, it becomes available as a utility function within the platform's workflow builder, supporting automation, validation, data integrity, and transformation scenarios.
11+
The SHA Hashing Plugin allows FlowSynx users to:
12+
13+
- Compute secure hash digests for input text or binary data.
14+
- Support workflows involving data integrity checks, digital signatures, or secure token generation.
15+
- Use configurable hashing algorithms without writing code.
16+
- Generate hashes with fixed or variable-length outputs (for SHAKE algorithms).
1217

1318
---
1419

15-
## Supported Algorithms
20+
## Supported Operations
1621

1722
The plugin supports the following hash algorithms:
1823

19-
- SHA-1
20-
- SHA-224
21-
- SHA-256
22-
- SHA-384
23-
- SHA-512
24-
- SHA-512/224
25-
- SHA-512/256
26-
- SHA3-224
27-
- SHA3-256
28-
- SHA3-384
29-
- SHA3-512
30-
- SHAKE128 (configurable output length)
31-
- SHAKE256 (configurable output length)
32-
33-
## Notes
34-
35-
- This plugin is supported exclusively within the FlowSynx platform.
36-
- It is installed automatically by the FlowSynx engine.
37-
- All hashing logic is securely executed within the FlowSynx runtime.
38-
- Plugin input (e.g., text, bytes, output length) is configured through FlowSynx-managed specifications.
39-
- SHAKE algorithms support customizable output lengths defined in the plugin specification.
24+
- **SHA-1**
25+
- **SHA-224**
26+
- **SHA-256**
27+
- **SHA-384**
28+
- **SHA-512**
29+
- **SHA-512/224**
30+
- **SHA-512/256**
31+
- **SHA3-224**
32+
- **SHA3-256**
33+
- **SHA3-384**
34+
- **SHA3-512**
35+
- **SHAKE128** (configurable output length)
36+
- **SHAKE256** (configurable output length)
37+
38+
---
39+
40+
## Plugin Specifications
41+
42+
This plugin does not require external configuration. It is ready to use within FlowSynx workflows.
43+
44+
---
45+
46+
## Input Parameters
47+
48+
| Parameter | Type | Required | Description |
49+
|------------------|----------|----------|-------------------------------------------------------------------------------------------------|
50+
| `Algorithm` | string | Yes | The hashing algorithm to use (e.g., `sha256`, `sha3-512`, `shake128`). |
51+
| `InputText` | string | No | The input text to hash (UTF-8 encoded). Either `InputText` or `InputBytes` **must** be provided.|
52+
| `InputBytes` | byte[] | No | The raw binary data to hash. Either `InputText` or `InputBytes` **must** be provided. |
53+
| `OutputLength` | int | No | The desired output length in bytes for SHAKE algorithms. Ignored for fixed-length algorithms. |
54+
55+
---
56+
57+
### Example Input (SHA-256)
58+
59+
```json
60+
{
61+
"Operation": "sha256",
62+
"InputText": "Hello, FlowSynx!"
63+
}
64+
```
65+
66+
### Example Input (SHAKE128 with custom output length)
67+
68+
```json
69+
{
70+
"Operation": "shake128",
71+
"InputText": "Custom output hash",
72+
"OutputLength": 64
73+
}
74+
```
75+
76+
---
77+
78+
## Debugging Tips
79+
80+
- Ensure the `Algorithm` name matches one of the supported operations (case-insensitive).
81+
- Provide either `InputText` or `InputBytes`, but not both simultaneously.
82+
- For SHAKE algorithms, specify `OutputLength` to define the size of the output hash. If omitted, a default length may be applied.
83+
- Binary outputs are Base64 encoded in FlowSynx for easy handling.
84+
85+
---
86+
87+
## Security Notes
88+
89+
- All hash computations are performed in memory and are not persisted beyond the workflow execution.
90+
- No sensitive input data is stored unless explicitly configured in the workflow.
91+
- The plugin uses secure, well-tested cryptographic libraries provided by the FlowSynx runtime.
4092

4193
---
4294

‎src/README.md‎

Lines changed: 78 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,94 @@
1-
## FlowSynx SHA Hash Plugin – FlowSynx Platform Integration
1+
## FlowSynx SHA Hashing Plugin
22

3-
The SHA Hash Plugin is a secure, plug-and-play component for the FlowSynx engine. It enables the computation of various SHA family hashes (including SHA-1, SHA-2, SHA-3, and SHAKE) from text or binary data, and is designed to seamlessly integrate into FlowSynx’s no-code/low-code automation workflows.
3+
The **SHA Hashing Plugin** is a pre-packaged, plug-and-play integration component for the FlowSynx engine. It provides a wide range of secure hashing algorithms, including SHA-1, SHA-2, SHA-3, and SHAKE variants, enabling workflows to compute cryptographic hashes of input data. This plugin supports both text and binary data and allows configurable output lengths for extendable-output functions (XOF) like SHAKE128 and SHAKE256.
44

5-
This plugin is automatically installed and managed by the FlowSynx engine when selected within the platform. It is not intended for standalone use or manual installation outside the FlowSynx environment.
5+
This plugin is automatically installed by the FlowSynx engine when selected within the platform. It is not intended for manual installation or standalone developer use outside the FlowSynx environment.
66

77
---
88

99
## Purpose
1010

11-
This plugin allows FlowSynx users to generate cryptographic hash values using a range of SHA algorithms for input values as part of their workflow logic—without writing any code. Once activated, it becomes available as a utility function within the platform's workflow builder, supporting automation, validation, data integrity, and transformation scenarios.
11+
The SHA Hashing Plugin allows FlowSynx users to:
12+
13+
- Compute secure hash digests for input text or binary data.
14+
- Support workflows involving data integrity checks, digital signatures, or secure token generation.
15+
- Use configurable hashing algorithms without writing code.
16+
- Generate hashes with fixed or variable-length outputs (for SHAKE algorithms).
1217

1318
---
1419

15-
## Supported Algorithms
20+
## Supported Operations
1621

1722
The plugin supports the following hash algorithms:
1823

19-
- SHA-1
20-
- SHA-224
21-
- SHA-256
22-
- SHA-384
23-
- SHA-512
24-
- SHA-512/224
25-
- SHA-512/256
26-
- SHA3-224
27-
- SHA3-256
28-
- SHA3-384
29-
- SHA3-512
30-
- SHAKE128 (configurable output length)
31-
- SHAKE256 (configurable output length)
32-
33-
## Notes
34-
35-
- This plugin is supported exclusively within the FlowSynx platform.
36-
- It is installed automatically by the FlowSynx engine.
37-
- All hashing logic is securely executed within the FlowSynx runtime.
38-
- Plugin input (e.g., text, bytes, output length) is configured through FlowSynx-managed specifications.
39-
- SHAKE algorithms support customizable output lengths defined in the plugin specification.
24+
- **SHA-1**
25+
- **SHA-224**
26+
- **SHA-256**
27+
- **SHA-384**
28+
- **SHA-512**
29+
- **SHA-512/224**
30+
- **SHA-512/256**
31+
- **SHA3-224**
32+
- **SHA3-256**
33+
- **SHA3-384**
34+
- **SHA3-512**
35+
- **SHAKE128** (configurable output length)
36+
- **SHAKE256** (configurable output length)
37+
38+
---
39+
40+
## Plugin Specifications
41+
42+
This plugin does not require external configuration. It is ready to use within FlowSynx workflows.
43+
44+
---
45+
46+
## Input Parameters
47+
48+
| Parameter | Type | Required | Description |
49+
|------------------|----------|----------|-------------------------------------------------------------------------------------------------|
50+
| `Algorithm` | string | Yes | The hashing algorithm to use (e.g., `sha256`, `sha3-512`, `shake128`). |
51+
| `InputText` | string | No | The input text to hash (UTF-8 encoded). Either `InputText` or `InputBytes` **must** be provided.|
52+
| `InputBytes` | byte[] | No | The raw binary data to hash. Either `InputText` or `InputBytes` **must** be provided. |
53+
| `OutputLength` | int | No | The desired output length in bytes for SHAKE algorithms. Ignored for fixed-length algorithms. |
54+
55+
---
56+
57+
### Example Input (SHA-256)
58+
59+
```json
60+
{
61+
"Operation": "sha256",
62+
"InputText": "Hello, FlowSynx!"
63+
}
64+
```
65+
66+
### Example Input (SHAKE128 with custom output length)
67+
68+
```json
69+
{
70+
"Operation": "shake128",
71+
"InputText": "Custom output hash",
72+
"OutputLength": 64
73+
}
74+
```
75+
76+
---
77+
78+
## Debugging Tips
79+
80+
- Ensure the `Algorithm` name matches one of the supported operations (case-insensitive).
81+
- Provide either `InputText` or `InputBytes`, but not both simultaneously.
82+
- For SHAKE algorithms, specify `OutputLength` to define the size of the output hash. If omitted, a default length may be applied.
83+
- Binary outputs are Base64 encoded in FlowSynx for easy handling.
84+
85+
---
86+
87+
## Security Notes
88+
89+
- All hash computations are performed in memory and are not persisted beyond the workflow execution.
90+
- No sensitive input data is stored unless explicitly configured in the workflow.
91+
- The plugin uses secure, well-tested cryptographic libraries provided by the FlowSynx runtime.
4092

4193
---
4294

0 commit comments

Comments
 (0)