@sentriflow/cli 0.2.0 → 0.2.1

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.
Files changed (3) hide show
  1. package/README.md +40 -0
  2. package/dist/index.js +1827 -360
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -111,6 +111,46 @@ Supported vendors: `cisco-ios`, `juniper-junos`, `palo-alto`, `fortinet`, `arist
111
111
  | `--license-key <key>` | License key (or set `SENTRIFLOW_LICENSE_KEY` env var) |
112
112
  | `--strict-packs` | Fail if encrypted pack cannot be loaded |
113
113
 
114
+ ### Extended Encrypted Packs (GRX2)
115
+
116
+ Extended GRX2 packs (.grx2) embed wrapped encryption keys, enabling offline scanning without network access.
117
+
118
+ | Option | Description |
119
+ |--------|-------------|
120
+ | `--grx2-pack <path...>` | Path(s) to extended encrypted rule pack(s) (.grx2) |
121
+ | `--strict-grx2` | Fail immediately if any GRX2 pack cannot be loaded |
122
+ | `--show-machine-id` | Display the current machine ID (for license binding support) |
123
+
124
+ **Environment Variable:**
125
+ - `SENTRIFLOW_LICENSE_KEY` - License key for decrypting packs
126
+
127
+ **Offline Usage:**
128
+
129
+ GRX2 packs contain embedded wrapped keys, allowing complete offline operation:
130
+
131
+ ```bash
132
+ # Scan with portable pack (no network required)
133
+ SENTRIFLOW_LICENSE_KEY=ey... sentriflow --grx2-pack ./enterprise-rules.grx2 router.conf
134
+
135
+ # Scan with multiple packs
136
+ sentriflow --grx2-pack pack1.grx2 pack2.grx2 --license-key ey... configs/
137
+
138
+ # Strict mode: fail on pack load errors
139
+ sentriflow --grx2-pack rules.grx2 --strict-grx2 router.conf
140
+ ```
141
+
142
+ **Machine-Bound vs Portable Packs:**
143
+
144
+ - **Portable packs**: Work on any machine with a valid license key
145
+ - **Machine-bound packs**: Tied to a specific machine ID for additional security
146
+
147
+ Use `--show-machine-id` to display your machine ID when requesting machine-bound packs:
148
+
149
+ ```bash
150
+ sentriflow --show-machine-id
151
+ # Output: Machine ID: a1b2c3d4...
152
+ ```
153
+
114
154
  ### Directory Scanning
115
155
 
116
156
  | Option | Description |