Metadata-Version: 2.4
Name: loggen-cli
Version: 0.2.0
Summary: Generate realistic SOC analyst training logs with MITRE ATT&CK technique mapping
Author-email: Himangshu Pan <contrivance.databank@gmail.com>
License:                                  Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship, whether in Source or
              Object form, made available under the License, as indicated by a
              copyright notice that is included in or attached to the work
              (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other modifications
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean any work of authorship, including
              the original version of the Work and any modifications or additions
              to that Work or Derivative Works thereof, that is intentionally
              submitted to Licensor for inclusion in the Work by the copyright owner
              or by an individual or Legal Entity authorized to submit on behalf of
              the copyright owner. For the purposes of this definition, "submitted"
              means any form of electronic, verbal, or written communication sent
              to the Licensor or its representatives, including but not limited to
              communication on electronic mailing lists, source code control systems,
              and issue tracking systems that are managed by, or on behalf of, the
              Licensor for the purpose of discussing and improving the Work, but
              excluding communication that is conspicuously marked or otherwise
              designated in writing by the copyright owner as "Not a Contribution."
        
              "Contributor" shall mean Licensor and any individual or Legal Entity
              on behalf of whom a Contribution has been received by Licensor and
              subsequently incorporated within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent claims licensable
              by such Contributor that are necessarily infringed by their
              Contribution(s) alone or by combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted. If You
              institute patent litigation against any entity (including a
              cross-claim or counterclaim in a lawsuit) alleging that the Work
              or a Contribution incorporated within the Work constitutes direct
              or contributory patent infringement, then any patent licenses
              granted to You under this License for that Work shall terminate
              as of the date such litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or
                  Derivative Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file as part of its
                  distribution, then any Derivative Works that You distribute must
                  include a readable copy of the attribution notices contained
                  within such NOTICE file, excluding those notices that do not
                  pertain to any part of the Derivative Works, in at least one
                  of the following places: within a NOTICE text file distributed
                  as part of the Derivative Works; within the Source form or
                  documentation, if provided along with the Derivative Works; or,
                  within a display generated by the Derivative Works, if and
                  wherever such third-party notices normally appear. The contents
                  of the NOTICE file are for informational purposes only and
                  do not modify the License. You may add Your own attribution
                  notices within Derivative Works that You distribute, alongside
                  or as an addendum to the NOTICE text from the Work, provided
                  that such additional attribution notices cannot be construed
                  as modifying the License.
        
              You may add Your own copyright statement to Your modifications and
              may provide additional or different license terms and conditions
              for use, reproduction, or distribution of Your modifications, or
              for any such Derivative Works as a whole, provided Your use,
              reproduction, and distribution of the Work otherwise complies with
              the conditions stated in this License.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or redistributing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or consequential damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or any and all
              other commercial damages or losses), even if such Contributor
              has been advised of the possibility of such damages.
        
           9. Accepting Warranty or Additional Liability. While redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may act only
              on Your own behalf and on Your sole responsibility, not on behalf
              of any other Contributor, and only if You agree to indemnify,
              defend, and hold each Contributor harmless for any liability
              incurred by, or claims asserted against, such Contributor by reason
              of your accepting any such warranty or additional liability.
        
           END OF TERMS AND CONDITIONS
        
           APPENDIX: How to apply the Apache License to your work.
        
              To apply the Apache License to your work, attach the following
              boilerplate notice, with the fields enclosed by brackets "[]"
              replaced with your own identifying information. (Don't include
              the brackets!)  The text should be enclosed in the appropriate
              comment syntax for the file format. We also recommend that a
              file or class name and description of purpose be included on the
              same "printed page" as the copyright notice for easier
              identification within third-party archives.
        
           Copyright [yyyy] [name of copyright owner]
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License.
        
Project-URL: Homepage, https://github.com/sheru-pan/loggen
Project-URL: Source, https://github.com/sheru-pan/loggen
Project-URL: Issues, https://github.com/sheru-pan/loggen/issues
Project-URL: Docker Image, https://hub.docker.com/r/sheru/loggen
Keywords: soc,logs,mitre,security,training,threat-detection
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Security
Classifier: Topic :: System :: Logging
Classifier: Topic :: System :: Monitoring
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: typer>=0.9.0
Requires-Dist: pydantic>=1.9.0
Requires-Dist: faker>=15.0.0
Requires-Dist: httpx>=0.20.0
Requires-Dist: python-dotenv>=0.21.0
Requires-Dist: rich>=10.0.0
Provides-Extra: dev
Requires-Dist: pytest>=7.0.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
Requires-Dist: black>=23.0.0; extra == "dev"
Requires-Dist: ruff>=0.1.0; extra == "dev"
Requires-Dist: mypy>=1.0.0; extra == "dev"
Dynamic: license-file

# Loggen - SOC Analyst Training Log Generator

A Python CLI tool that generates realistic, machine-detectable security logs for SOC analyst training. Loggen creates logs mimicking real-world attack scenarios with MITRE ATT&CK technique mapping, making it ideal for hands-on threat detection practice.

## Features

✨ **Multiple Log Types**
- Authentication/Access logs (SSH, system auth)
- Firewall logs (blocked connections, port scans, DDoS)
- IDS/IPS alerts (exploits, malware signatures, anomalies)
- Web server logs (HTTP requests, web attacks)
- System event logs (process creation, file operations, registry changes)

🎯 **MITRE ATT&CK Integration**
- Map techniques to realistic log patterns
- Generate logs for specific techniques (e.g., `loggen mitre T1110.001`)
- Training-focused scenario design

🔧 **Flexible Output**
- Multiple formats: raw text, JSON, CEF, syslog
- Write to files or stdout
- Mix normal baseline traffic with malicious activity (configurable ratio)

📊 **Realistic Data**
- Uses Faker library for authentic usernames, IPs, domains, hostnames
- Realistic timestamps and traffic patterns
- Configurable malicious/benign event distribution (default 20-30%)

## Installation

### From PyPI (Recommended)

```bash
pip install loggen-cli
loggen --help
```

Or with [pipx](https://pipx.pypa.io) for an isolated install:

```bash
pipx install loggen-cli
```

### From Docker Hub

```bash
docker pull sheru/loggen:latest
docker run --rm -v /loggen/fake/log:/logs sheru/loggen \
  loggen auth bruteforce --count 100 --output attack.log
```

See [DOCKER.md](DOCKER.md) for the full Docker workflow.

### From Source (developer install)

```bash
git clone git@github.com:sheru-pan/loggen.git
cd loggen
python3 -m venv venv
source venv/bin/activate
pip install -e .
```

See [DEVELOPING.md](DEVELOPING.md) for contributor notes.

## Quick Start

### Generate Auth Logs (Brute Force Attack)

```bash
loggen auth bruteforce --count 20 --output auth_attack.log
```

### Generate Firewall Logs (Port Scan)

```bash
loggen firewall portscan --count 10
```

### Generate Web Attack Logs (JSON Format)

```bash
loggen web attack --count 15 --format json --output web_attacks.json
```

### Generate IDS Alerts

```bash
loggen ids alert --count 5
```

### Generate MITRE ATT&CK Technique Logs

```bash
# T1110.001 - Brute Force: Password Guessing
loggen mitre T1110.001 --count 20

# T1078.001 - Valid Accounts: Default Accounts
loggen mitre T1078.001 --count 10
```

### List Available Scenarios

```bash
loggen list --type scenarios
loggen list --type generators
```

## Usage Guide

### Command Syntax

```bash
loggen <generator> [scenario] [options]
```

### Generators

| Generator | Description | Scenarios |
|-----------|-------------|-----------|
| `auth` | Authentication & access logs | `bruteforce`, `successful`, `invalid_user`, `privilege_escalation`, `account_lockout`, `default_credentials` |
| `firewall` | Firewall & network logs | `blocked`, `portscan`, `ddos`, `allowed`, `unusual_traffic` |
| `ids` | IDS/IPS alert logs | `alert`, `exploit`, `trojan`, `anomaly`, `intrusion` |
| `web` | Web server logs | `attack`, `normal`, `scan`, `unauthorized`, `abuse` |
| `system` | System event logs | `process`, `file`, `registry`, `service`, `user`, `privilege` |
| `mitre` | MITRE ATT&CK techniques | Various (mapped to generators) |

### Options

```bash
--count, -c COUNT           Number of logs to generate (default: 10)
--output, -o PATH          Output file path (default: stdout)
--format, -f FORMAT        Output format: raw, json, cef, syslog (default: raw)
```

### Output Formats

#### Raw (Default)
```
2026-05-23T02:57:51.637517 auth [WARNING] ssh_auth_failure: Failed password for user from 68.96.247.16 port 58542 ssh2
```

#### JSON
```json
{
  "timestamp": "2026-05-23T02:57:51.637517",
  "source": "auth",
  "event_type": "ssh_auth_failure",
  "level": "WARNING",
  "message": "Failed password for user from 68.96.247.16 port 58542 ssh2",
  "fields": {
    "user": "user",
    "source_ip": "68.96.247.16",
    "port": 58542
  }
}
```

#### CEF (Common Event Format)
```
CEF:0|loggen|auth|1.0|ssh_auth_failure|Failed password for user from 68.96.247.16 port 58542 ssh2|5|user=user src_ip=68.96.247.16 port=58542
```

#### Syslog
```
<38>May 23 02:57:51 loggen-host auth[ssh_auth_failure]: Failed password for user from 68.96.247.16 port 58542 ssh2
```

## Examples

### Simulate a Brute Force Attack
```bash
loggen auth bruteforce --count 100 --output scenarios/brute_force.log
```

### Generate DDoS Log Pattern
```bash
loggen firewall ddos --count 50 --format json --output scenarios/ddos_attack.json
```

### Create Web Application Attack Mix
```bash
loggen web attack --count 30 --output scenarios/web_attacks.log
```

### System Privilege Escalation Scenario
```bash
loggen system privilege --count 20 --output scenarios/priv_esc.log
```

### MITRE ATT&CK Training Scenarios

```bash
# Credential Access - Brute Force
loggen mitre T1110.001 --count 25 --output mitre/T1110.001.log

# Initial Access - Valid Accounts
loggen mitre T1078.001 --count 15 --output mitre/T1078.001.log

# Persistence - Privilege Escalation
loggen mitre T1021.006 --count 20 --output mitre/T1021.006.log
```

## Supported MITRE ATT&CK Techniques

- **T1110.001** - Brute Force: Password Guessing
- **T1110.003** - Brute Force: Password Spraying
- **T1078.001** - Valid Accounts: Default Accounts
- **T1021.006** - Remote Services: Windows Remote Management
- **T1021.001** - Remote Services: Remote Terminal Protocol
- **T1040.001** - Traffic Sniffing
- **T1056** - Reconnaissance

## Architecture

```
loggen/
├── models/              # Pydantic data models
│   ├── log_event.py    # LogEvent base model with format support
│   └── scenario.py     # Scenario configuration model
├── generators/          # Log generation modules
│   ├── base.py         # BaseGenerator abstract class
│   ├── auth.py         # Authentication generator
│   ├── firewall.py     # Firewall generator
│   ├── ids_ips.py      # IDS/IPS generator
│   ├── web.py          # Web server generator
│   └── system.py       # System event generator
├── outputs/             # Output handlers
│   ├── base.py         # BaseOutputHandler
│   ├── file_output.py  # File output handler
│   └── stdout_output.py # Stdout handler
├── utils/               # Utilities
│   ├── faker_config.py  # Faker configuration
│   ├── timestamps.py    # Timestamp generation
│   └── constants.py    # Log templates and constants
└── cli.py              # Typer CLI interface
```

## Customization

### Adjusting Malicious Event Ratio

Each generator accepts a `malicious_ratio` parameter (0.0-1.0):

```python
from loggen.generators.auth import AuthGenerator

# 50% malicious events instead of default 20%
generator = AuthGenerator(malicious_ratio=0.5)
events = generator.generate(count=20, scenario="bruteforce")
```

### Adding Custom Log Patterns

Extend any generator:

```python
from loggen.generators.auth import AuthGenerator
from loggen.models.log_event import LogEvent, LogLevel

class CustomAuthGenerator(AuthGenerator):
    def _generate_custom_scenario(self, count: int):
        events = []
        for i in range(count):
            # Custom logic here
            pass
        return events
```

## Testing & Development

Run tests:

```bash
source venv/bin/activate
pytest tests/ -v
```

Run with debugging:

```bash
loggen auth bruteforce --count 5 --format json
```

## Performance

- **Small scenarios** (1-100 logs): < 1 second
- **Medium scenarios** (100-1000 logs): 1-5 seconds
- **Large scenarios** (1000+ logs): Scales linearly

## Known Limitations

- MITRE technique mapping is currently hardcoded (expandable in future)
- SIEM integration (Splunk, ELK) planned for Phase 3
- Configuration file support planned

## Future Enhancements

- [ ] SIEM direct integration (Splunk HEC, Elasticsearch API)
- [ ] Configuration file support (~/.loggen/config.yaml)
- [ ] Extended MITRE technique coverage
- [ ] Custom log template support
- [ ] Scenario replay with seeds
- [ ] Performance profiling & optimization

## Contributing

This is an educational project for SOC analyst training. Contributions welcome for:
- Additional log generators
- More MITRE ATT&CK techniques
- SIEM integrations
- Test coverage

## License

MIT License

## Author

Built for cybersecurity training and threat detection practice.

## Support

For issues, feature requests, or questions:
- Open an issue on GitHub
- Check existing documentation
- Review example scenarios

## Disclaimer

This tool generates **simulated logs for training purposes only**. Logs are realistic but not based on real-world attacks. Use responsibly for educational and authorized security testing only.
