Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.7%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: PMaynard
  • License: mit
  • Language: Go
  • Default Branch: master
  • Size: 1.29 MB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created over 2 years ago · Last pushed almost 2 years ago
Metadata Files
Readme License Citation

README.md

Security Model Converter (SMC)

SMC is an Open-Source command-line application written in GoLang that converts security model data to different formats. SMC supports conversion between SAND Attack Trees, Dependency Models, and FRIPP (see supported formats below). SMC is designed to work alongside the Security Modelling Framework (SecMoF) tool.

SMC uses GraphML as an intermediate format to allow conversion of the different formats, since GraphML is a widely used format it may be used to import/export the models into other tools, including and beyond SecMoF.

Install

Golang is required to compile and run this tool. Final versions will have release binaries.

go install github.com/PMaynard/smc@latest

Usage

The tool converts models between each other using GraphML as a common format. bash smc [fripp|dm|idm|sand] in.fripp out.graphml

Convert a SAND Attack Tree into SecMoF FRIP Playbook:

bash smc sand testdata/sand/example.ctrees example.fripp

Convert FRIP Playbook to GraphML bash smc fripp testdata/fripp/example.fripp example.graphml

Supported Formats (IN|OUT)

| Format | CTree | GraphML | SecMoF | iDepend | | --------------: | :-----: | :------: | :------: | :-----: | | SAND Attack Trees | Y|N | Y|Y | -|- | -|- | | Dependency Model | -|- | Y|Y | Y|Y | Y|N | | Playbook Process | -|-| Y|Y | Y|Y | -|- |

Non-Goals

  • Output SAND Attack Trees.
  • Output iDepend XML models.
  • Replace the Eclipse based Security Modelling Framework Tool (SecMoF).

Example

The below file is a textual representation of SAND Attack Trees using tabs to indicate a child node of the above line.

By running: smc sand data/ctrees/common.ctrees common.fripp the Attack Tree is converted into a XML file that can be read by SecMoF then formally verified using the tool.

**File: data/ctrees/common.ctrees

*
    Reconnaissance 
        Day-to-day Operations
        Operator Behaviour 
        Network Patterns
        Network Services
        System Processes
    Propagate : SAND
        Lateral Movement
            Living off the Land
            Domain Controller
            Stolen Credentials
            Spear-phishing
            Water Hole
            Removable Storage
            Internal P2P Comms.
        Command and Control
    Payload : SAND
        Fileless Operation
        Actively Bypass Detection
        Zero Day Exploit
        Reconn
            Passive Network Monitoring
            Enumerate Fieldbus Devices
            Exfiltrate Targeted Files
        Destructive
            Target Industrial Devices
            DoS
            False Data
            Transmit Malicious Commands 
            Modify Firmware

**Figure 1: Common SAND Attack Tree loaded into SecMof after being converted, with the original Attack Tree on the right.

Development

Testing

View test coverage. Currently have 85% of the statements covered by tests.

The primary focus has been on the SAND Attack Tree to SecMoF Playbook Process format, the other code paths were secondary.

go test -coverprofile=coverage.out
go tool cover -html=coverage.out

Models License

The Models, Playbooks, and SAND Attack Trees are licensed under CC BY-SA 4.0.

Code License

Copyright (c) 2023 Peter Maynard

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE./

Owner

  • Name: Pete
  • Login: PMaynard
  • Kind: user
  • Location: Wales, UK

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.

cff-version: 1.2.0
title: Secrutiy Model Converter (SMC)
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Peter
    family-names: Maynard
    email: pete@port22.co.uk
    orcid: 'https://orcid.org/0000-0002-6267-7530'
    affiliation: 'Cardiff University, UK'
repository-code: 'https://github.com/PMaynard/smc'
url: 'https://github.com/PMaynard/smc'
abstract: >-
  A tool for converting data between formalised and
  non-formalised formats via GraphML. 
keywords:
  - Formalised
  - SAND Attack Tree
  - FRIPP
  - GrapHML
license: MIT

GitHub Events

Total
Last Year

Dependencies

.github/workflows/go.yml actions
  • actions/checkout v3 composite
  • actions/setup-go v4 composite
go.mod go
  • github.com/beevik/etree v1.2.0
  • github.com/yaricom/goGraphML v1.1.0
go.sum go
  • github.com/beevik/etree v1.2.0
  • github.com/davecgh/go-spew v1.1.0
  • github.com/pmezard/go-difflib v1.0.0
  • github.com/stretchr/objx v0.1.0
  • github.com/stretchr/testify v1.6.1
  • github.com/yaricom/goGraphML v1.1.0
  • gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405
  • gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c