@greenarmor/ges-rules-engine 0.3.1 → 0.3.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +58 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
# @greenarmor/ges-rules-engine
|
|
2
|
+
|
|
3
|
+
Engineering standards enforcement rules for the [Green Engineering Standard Framework (GESF)](https://github.com/greenarmor/gesf).
|
|
4
|
+
|
|
5
|
+
Defines and validates security and compliance rules for data classification, authentication, encryption, secrets management, logging, database standards, API security, and storage.
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install @greenarmor/ges-rules-engine
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Exports
|
|
14
|
+
|
|
15
|
+
| Export | Description |
|
|
16
|
+
|--------|-------------|
|
|
17
|
+
| `ClassificationRule` | Interface for data classification rules |
|
|
18
|
+
| `CLASSIFICATION_RULES` | Rules per classification level (Public → Restricted) |
|
|
19
|
+
| `AuthRule` | Interface for authentication rules |
|
|
20
|
+
| `APPROVED_AUTH_METHODS` | Approved methods (Argon2id, MFA, Passkeys) |
|
|
21
|
+
| `REJECTED_AUTH_METHODS` | Rejected methods (MD5, SHA1, plain text) |
|
|
22
|
+
| `EncryptionRule` | Interface for encryption rules |
|
|
23
|
+
| `APPROVED_ENCRYPTION` | Approved algorithms (AES-256-GCM, ChaCha20-Poly1305, TLS 1.3) |
|
|
24
|
+
| `SecretsRule` | Interface for secrets management rules |
|
|
25
|
+
| `SECRETS_RULES` | Rules for vault integration, no secrets in code |
|
|
26
|
+
| `LoggingRule` | Interface for logging rules |
|
|
27
|
+
| `LOGGING_RULES` | What to log and what to never log |
|
|
28
|
+
| `DBStandard` | Interface for database standards |
|
|
29
|
+
| `DB_STANDARDS` | Required audit columns, soft delete, primary keys |
|
|
30
|
+
| `APIStandard` | Interface for API security standards |
|
|
31
|
+
| `API_STANDARDS` | Input validation, auth, rate limiting, audit logging |
|
|
32
|
+
| `StorageRule` | Interface for storage rules |
|
|
33
|
+
| `STORAGE_RULES` | Private by default, encryption, signed URLs, versioning |
|
|
34
|
+
|
|
35
|
+
## Usage
|
|
36
|
+
|
|
37
|
+
```typescript
|
|
38
|
+
import {
|
|
39
|
+
CLASSIFICATION_RULES,
|
|
40
|
+
APPROVED_ENCRYPTION,
|
|
41
|
+
REJECTED_AUTH_METHODS,
|
|
42
|
+
LOGGING_RULES
|
|
43
|
+
} from '@greenarmor/ges-rules-engine';
|
|
44
|
+
|
|
45
|
+
const restrictedRules = CLASSIFICATION_RULES['restricted'];
|
|
46
|
+
console.log(restrictedRules.requiresEncryption); // true
|
|
47
|
+
|
|
48
|
+
const approved = APPROVED_ENCRYPTION.map(r => r.algorithm);
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
## Related Packages
|
|
52
|
+
|
|
53
|
+
- [`@greenarmor/ges-core`](https://www.npmjs.com/package/@greenarmor/ges-core) — Types and constants
|
|
54
|
+
- [`@greenarmor/ges-compliance-engine`](https://www.npmjs.com/package/@greenarmor/ges-compliance-engine) — Control evaluation
|
|
55
|
+
|
|
56
|
+
## License
|
|
57
|
+
|
|
58
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@greenarmor/ges-rules-engine",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.3",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "GESF Rules Engine - Standards enforcement and validation rules",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
}
|
|
13
13
|
},
|
|
14
14
|
"dependencies": {
|
|
15
|
-
"@greenarmor/ges-core": "0.3.
|
|
15
|
+
"@greenarmor/ges-core": "0.3.3"
|
|
16
16
|
},
|
|
17
17
|
"devDependencies": {
|
|
18
18
|
"typescript": "^6.0.0",
|