Skip to main content

Lycan

Supported languages Build Status Coverage Status

Lycan is an implementation of the OpenC2 OASIS standard for command and control messaging. The current implementation is based on the Language Specification v1.0.

Given the influence of STIX/CyBoX on OpenC2, this library extends the STIX 2 Python API internals. Property validation and object extension support aligns with STIX2 conventions.

Installation

Install with pip:

$ pip install openc2

Usage

import iptc
from openc2 import parse, IPv4Address, Command, Response, Args

# encode
cmd = Command(action = "deny",
              target = IPv4Address(ipv4_net = "1.2.3.4"),
              args = Args(response_requested = "complete"))
msg = cmd.serialize()

# decode
cmd = parse(msg)
if cmd.action == "deny" and cmd.target.type == "ipv4_net":
    rule = iptc.Rule()
    rule.create_match(cmd.target.ipv4_net)
    rule.create_target("DROP")

    if cmd.args.response_requested == 'complete':
        resp = Response(status=200)
        msg = resp.serialize()

# custom actuator
from openc2 import CustomActuator
from stix2 import properties
@CustomActuator('x-acme-widget', [
    ('name', properties.StringProperty(required=True)),
    ('version', properties.FloatProperty())
])
class AcmeWidgetActuator(object):
    def __init__(self, version=None, **kwargs):
        if version and version < 1.0:
            raise ValueError("'%f' is not a supported version." % version)

widget = AcmeWidgetActuator(name="foo", version=1.1)

OASIS TC Open Repository: openc2-lycan-python

This GitHub public repository ( https://github.com/oasis-open/openc2-lycan-python ) was created at the request of the OASIS Open Command and Control (OpenC2) TC as an OASIS TC Open Repository to support development of open source resources related to Technical Committee work.

While this TC Open Repository remains associated with the sponsor TC, its development priorities, leadership, intellectual property terms, participation rules, and other matters of governance are separate and distinct from the OASIS TC Process and related policies.

All contributions made to this TC Open Repository are subject to open source license terms expressed in the MIT License. That license was selected as the declared "Applicable License" when the TC Open Repository was created.

As documented in "Public Participation Invited", contributions to this OASIS TC Open Repository are invited from all parties, whether affiliated with OASIS or not. Participants must have a GitHub account, but no fees or OASIS membership obligations are required. Participation is expected to be consistent with the OASIS TC Open Repository Guidelines and Procedures, the open source LICENSE designated for this particular repository, and the requirement for an Individual Contributor License Agreement that governs intellectual property.

Statement of Purpose

Statement of Purpose for this OASIS TC Open Repository (openc2-lycan-python) as proposed and approved [bis] by the TC:

The purpose of this OASIS TC Open repository is to develop and maintain a python implementation of OpenC2, and to provide a python codebase to facilitate other prototype efforts. The python library is designed to support transformations between data-interchange formats (such as JSON) and python language objects.

The OASIS OpenC2 Technical Committee was chartered to address matters as they pertain to command and control of cyber defense technologies, and to maintain a library of prototype implementations.

Additions to Statement of Purpose

Repository Maintainers may include here any clarifications — any additional sections, subsections, and paragraphs that the Maintainer(s) wish to add as descriptive text, reflecting (sub-) project status, milestones, releases, modifications to statement of purpose, etc. The project Maintainers will create and maintain this content on behalf of the participants.

Maintainers

TC Open Repository Maintainers are responsible for oversight of this project's community development activities, including evaluation of GitHub pull requests and preserving open source principles of openness and fairness. Maintainers are recognized and trusted experts who serve to implement community goals and consensus design preferences.

Initially, the associated TC members have designated one or more persons to serve as Maintainer(s); subsequently, participating community members may select additional or substitute Maintainers, per consensus agreements.

Current Maintainers of this TC Open Repository

Feedback

Questions or comments about this TC Open Repository's activities should be composed as GitHub issues or comments. If use of an issue/comment is not possible or appropriate, questions may be directed by email to the Maintainer(s) listed above. Please send general questions about TC Open Repository participation to OASIS Staff at repository-admin@oasis-open.org and any specific CLA-related questions to repository-cla@oasis-open.org.

Metadata

Release files for openc2 1.0.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for openc2 1.0.5
File Size Uploaded Provenance Actions
openc2-1.0.5.tar.gz 14.9 kB Without provenance Details for openc2-1.0.5.tar.gz

Release files / openc2-1.0.5.tar.gz

Download URL openc2-1.0.5.tar.gz
Size 14.9 kB
Tags Source
SHA-256 checksum
How to use checksums
675d467b4a064745ca147f6857252528cd44c949da9a8b6e1a76639ebd02c376
BLAKE2b-256 checksum
How to use checksums
b0cb9f64899408943c359d784fe5d87fd56cceb589c7b71487575b098b378019
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.44.1 CPython/3.6.4

Security for openc2 1.0.5

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page