jason-oneal commited on
Commit
16c5b78
·
verified ·
1 Parent(s): 4dd2a0e

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +86 -161
README.md CHANGED
@@ -10,200 +10,125 @@ tags:
10
  - trl
11
  ---
12
 
13
- # Model Card for Model ID
14
-
15
- <!-- Provide a quick summary of what the model is/does. -->
16
-
17
-
18
-
19
- ## Model Details
20
-
21
- ### Model Description
22
-
23
- <!-- Provide a longer summary of what this model is. -->
24
-
25
-
26
-
27
- - **Developed by:** [More Information Needed]
28
- - **Funded by [optional]:** [More Information Needed]
29
- - **Shared by [optional]:** [More Information Needed]
30
- - **Model type:** [More Information Needed]
31
- - **Language(s) (NLP):** [More Information Needed]
32
- - **License:** [More Information Needed]
33
- - **Finetuned from model [optional]:** [More Information Needed]
34
-
35
- ### Model Sources [optional]
36
-
37
- <!-- Provide the basic links for the model. -->
38
-
39
- - **Repository:** [More Information Needed]
40
- - **Paper [optional]:** [More Information Needed]
41
- - **Demo [optional]:** [More Information Needed]
42
-
43
- ## Uses
44
-
45
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
46
-
47
- ### Direct Use
48
-
49
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
50
-
51
- [More Information Needed]
52
-
53
- ### Downstream Use [optional]
54
-
55
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
56
-
57
- [More Information Needed]
58
-
59
- ### Out-of-Scope Use
60
-
61
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
62
-
63
- [More Information Needed]
64
-
65
- ## Bias, Risks, and Limitations
66
-
67
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
68
 
69
- [More Information Needed]
70
 
71
- ### Recommendations
72
 
73
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
74
 
75
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
76
 
77
- ## How to Get Started with the Model
78
 
79
- Use the code below to get started with the model.
80
 
81
- [More Information Needed]
 
 
 
 
 
82
 
83
- ## Training Details
84
 
85
- ### Training Data
86
 
87
- <!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
 
 
 
 
 
88
 
89
- [More Information Needed]
 
 
 
 
 
90
 
91
- ### Training Procedure
 
 
 
 
 
92
 
93
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
94
 
95
- #### Preprocessing [optional]
96
 
97
- [More Information Needed]
98
 
 
 
 
 
 
99
 
100
- #### Training Hyperparameters
101
 
102
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
103
 
104
- #### Speeds, Sizes, Times [optional]
105
 
106
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
 
 
 
 
 
107
 
108
- [More Information Needed]
109
 
110
  ## Evaluation
111
 
112
- <!-- This section describes the evaluation protocols and provides the results. -->
113
-
114
- ### Testing Data, Factors & Metrics
115
-
116
- #### Testing Data
117
-
118
- <!-- This should link to a Dataset Card if possible. -->
119
-
120
- [More Information Needed]
121
-
122
- #### Factors
123
-
124
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
125
-
126
- [More Information Needed]
127
-
128
- #### Metrics
129
-
130
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
131
-
132
- [More Information Needed]
133
-
134
- ### Results
135
-
136
- [More Information Needed]
137
-
138
- #### Summary
139
-
140
-
141
-
142
- ## Model Examination [optional]
143
-
144
- <!-- Relevant interpretability work for the model goes here -->
145
-
146
- [More Information Needed]
147
-
148
- ## Environmental Impact
149
-
150
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
151
-
152
- Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
153
-
154
- - **Hardware Type:** [More Information Needed]
155
- - **Hours used:** [More Information Needed]
156
- - **Cloud Provider:** [More Information Needed]
157
- - **Compute Region:** [More Information Needed]
158
- - **Carbon Emitted:** [More Information Needed]
159
-
160
- ## Technical Specifications [optional]
161
-
162
- ### Model Architecture and Objective
163
-
164
- [More Information Needed]
165
-
166
- ### Compute Infrastructure
167
-
168
- [More Information Needed]
169
-
170
- #### Hardware
171
-
172
- [More Information Needed]
173
-
174
- #### Software
175
-
176
- [More Information Needed]
177
-
178
- ## Citation [optional]
179
-
180
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
181
-
182
- **BibTeX:**
183
-
184
- [More Information Needed]
185
 
186
- **APA:**
 
 
 
 
 
187
 
188
- [More Information Needed]
189
 
190
- ## Glossary [optional]
191
 
192
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
 
 
 
 
193
 
194
- [More Information Needed]
195
 
196
- ## More Information [optional]
197
 
198
- [More Information Needed]
199
 
200
- ## Model Card Authors [optional]
201
 
202
- [More Information Needed]
203
 
204
- ## Model Card Contact
205
 
206
- [More Information Needed]
207
- ### Framework versions
208
 
209
- - PEFT 0.18.0
 
10
  - trl
11
  ---
12
 
13
+ ---
14
+ license: apache-2.0
15
+ base_model: p-e-w/gpt-oss-20b-heretic
16
+ tags:
17
+ - cybersecurity
18
+ - penetration-testing
19
+ - red-team
20
+ - orchestration
21
+ - lora
22
+ - security-ai
23
+ - secgpt
24
+ language:
25
+ - en
26
+ ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
27
 
28
+ # secgpt-base-lora
29
 
30
+ ## Model Summary
31
 
32
+ **secgpt-base-lora** is a LoRA fine-tune created to transform a permissive large language model into a **cybersecurity orchestration engine**.
33
 
34
+ The model is designed to plan, reason, and structure penetration testing workflows while enforcing scope, constraints, and rules of engagement. It does **not** perform exploitation, scanning, or live attacks.
35
 
36
+ This model serves as the **base orchestrator** for the SecGPT project and is intended to be embedded inside controlled agent frameworks.
37
 
38
+ ## Base Model
39
 
40
+ - **Base model:** `p-e-w/gpt-oss-20b-heretic`
41
+ - **Original lineage:** `openai/gpt-oss-20b`
42
+ - **Architecture:** Decoder-only transformer (MoE-based, inherited)
43
+ - **Fine-tuning method:** LoRA (Low-Rank Adaptation)
44
+ - **Precision:** BF16 compatible
45
+ - **Author:** Jason O’Neal
46
 
47
+ The Heretic base model was chosen specifically for its reduced refusal behavior, allowing orchestration logic to be learned without fighting upstream safety refusals.
48
 
49
+ ## Intended Use
50
 
51
+ ### Primary Purpose
52
+ - Penetration testing orchestration
53
+ - Red team workflow planning
54
+ - Tool selection and sequencing
55
+ - Scope and constraint enforcement
56
+ - Structured, machine-readable output generation
57
 
58
+ ### Example Tasks
59
+ - Plan non-destructive external assessments
60
+ - Select appropriate tools based on scope and target type
61
+ - Generate ordered testing workflows
62
+ - Produce strict JSON plans for downstream agents
63
+ - Refuse out-of-scope or unsafe requests
64
 
65
+ ### Explicitly Out of Scope
66
+ - Autonomous exploitation
67
+ - Payload generation
68
+ - Malware development
69
+ - Live attack execution
70
+ - Social engineering automation
71
 
72
+ This model plans. Execution belongs elsewhere.
73
 
74
+ ## Training Data
75
 
76
+ The model was fine-tuned on a **custom, hand-curated cybersecurity orchestration dataset**, including:
77
 
78
+ - Penetration testing plans
79
+ - Tool-centric workflows with explicit arguments
80
+ - Scope, ROE, and constraint handling
81
+ - Failure handling and recovery scenarios
82
+ - Structured JSON outputs validated against schemas
83
 
84
+ No proprietary data, real credentials, or live targets were used.
85
 
86
+ ## Output Format
87
 
88
+ The model strongly prefers **strict JSON outputs**.
89
 
90
+ Typical responses include:
91
+ - Objectives
92
+ - Constraints
93
+ - Ordered steps
94
+ - Tool names and arguments
95
+ - Expected outcomes
96
 
97
+ Unstructured or conversational output is intentionally discouraged.
98
 
99
  ## Evaluation
100
 
101
+ Evaluation focuses on **behavioral correctness**, not stylistic quality:
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
102
 
103
+ - Tool selection accuracy
104
+ - Argument validity
105
+ - JSON schema compliance
106
+ - Scope enforcement
107
+ - Proper refusal behavior
108
+ - Recovery after simulated tool failure
109
 
110
+ Hallucinated tools, invented results, or fabricated flags are treated as failures.
111
 
112
+ ## Limitations
113
 
114
+ - Does not execute tools or commands
115
+ - Depends on the host framework for enforcement
116
+ - Can hallucinate if misused or prompted incorrectly
117
+ - Not a replacement for human judgment
118
+ - Requires external validation and guardrails
119
 
120
+ This is an orchestrator, not an autopwn engine.
121
 
122
+ ## Ethical Considerations
123
 
124
+ This model is intended solely for **authorized security testing and defensive research**.
125
 
126
+ Users are responsible for ensuring compliance with applicable laws, contracts, and rules of engagement. Misuse reflects on the user, not the model.
127
 
128
+ ## License
129
 
130
+ Apache License 2.0
131
 
132
+ ## Acknowledgments
 
133
 
134
+ Developed as part of the **SecGPT** project, focused on building modular, auditable, and controllable AI-assisted security tooling.