Initial Commit from UMBC Server

.editorconfig

@@ -0,0 +1,16 @@
+# Standard text editor settings.
+# See: https://editorconfig.org/
+
+root = true
+
+[*]
+end_of_line =  = lf
+insert_final_newline = true
+
+[*.{js, py}]
+charset = utf-8
+indent_style = space
+indent_size = 4
+
+[Makefile]
+indent_style = tab

.gitattributes

@@ -0,0 +1,2 @@
+; Force unix line endings for all text files
+* text=auto

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/build_website.yml

@@ -0,0 +1,164 @@
+name: Build Website
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - '.github/workflows/**'
+      - 'src/**'
+      - 'data/**/*.json'
+  pull_request:
+    paths:
+      - '.github/workflows/**'
+      - 'src/**'
+      - 'data/**/*.json'
+  workflow_dispatch:
+
+# If another web build starts for the same branch, cancel the previous build. This
+# protects us from two builds trying to upload at the same time and clobbering each
+# other.
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+  id-token: write
+  pages: write
+  pull-requests: write
+
+jobs:
+  tie_website_build:
+    runs-on: ubuntu-latest
+    env:
+      BRANCH_NAME: ${{ github.ref_name == 'main' && 'technique-inference-engine' || github.ref_name }}
+    steps:
+
+      # Configure Environment
+      - uses: actions/checkout@v4
+
+      # Configure Node
+      - uses: actions/setup-node@v4
+        id: "setup-node"
+        with:
+          node-version: '19'
+          cache: 'npm'
+          cache-dependency-path: 'src/tie-web-interface/package-lock.json'
+      - name: Install dependencies
+        working-directory: src/tie-web-interface/
+        run: npm ci
+
+      # Lint
+      - name: Lint
+        working-directory: src/tie-web-interface/
+        run: npm run lint
+
+      # Run Type Checks
+      - name: Type Check
+        working-directory: src/tie-web-interface/
+        run: npm run type-check
+
+      # Configure Python
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.11.8'
+      - name: Install Poetry
+        run: curl -sSL https://install.python-poetry.org/ | python -
+      - name: Add Poetry to PATH
+        run: echo "$HOME/.poetry/bin" >> $GITHUB_PATH
+      - name: Install dependencies
+        run: poetry install
+
+      # Train Model
+      - name: Retrain Technique Inference Engine Model
+        working-directory: src/tie-web-interface/
+        run: npm run build-model
+
+      # Build Website
+      - name: Compile Website
+        working-directory: src/tie-web-interface/
+        run: npm run build-only -- --base /technique-inference-engine/
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: tie_website
+          path: src/tie-web-interface/dist/
+
+  # Publish to Azure blob only on PRs, not main.
+  azure_blob:
+    if: github.ref_name != 'main'
+    needs: tie_website_build
+    runs-on: ubuntu-latest
+    env:
+      AZURE_STORAGE_ACCOUNT: techniqueinferenceengine
+      AZURE_STORAGE_SAS_TOKEN: ${{ secrets.AZURE_SAS_TOKEN }}
+      BRANCH_NAME: ${{ github.head_ref || github.ref_name }}
+      STATICRYPT_PASS: ${{ secrets.STATICRYPT_PASS }}
+    steps:
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "19"
+      - run: npm install -g staticrypt
+      - name: Download Web Site
+        uses: actions/download-artifact@v4
+        with:
+          name: tie_website
+          path: tie_website
+      - env:
+          STATICRYPT_PASS: ${{ secrets.STATICRYPT_PASS }}
+        run: >
+          staticrypt --remember 3 --salt b1c18fbb5081eca3e2db08a413b01774 \
+            --password $STATICRYPT_PASS --short \
+            --template-title "Technique Inference Engine (branch: $BRANCH_NAME)" \
+            --template-instructions "The contents of this site are marked TLP:AMBER:CTID-R&D:22-80. Do not share with unauthorized individuals." \
+            --template-color-primary "#6241c5" \
+            --template-color-secondary "#b2b2b2" \
+            --template-button "Log In" \
+            -r tie_website/
+      - name: Ensure StatiCrypt ran # StatiCrypt will fail without warning; verify it created a directory
+        run: test -d encrypted
+      - name: Copy encrypted HTML files
+        run: rsync -Ir -v --include='*.html' --exclude='*.*' encrypted/tie_website .
+      - name: Set the branch name
+        run: mv tie_website "$BRANCH_NAME"
+      - name: Install Azure CLI
+        run: curl -sL https://aka.ms/InstallAzureCLIDeb | sudo bash
+      - name: Delete old blobs
+        run: az storage blob delete-batch -s '$web' --pattern "$BRANCH_NAME/*"
+      - name: Upload to blob storage
+        run: az storage blob upload-batch -s . --pattern "$BRANCH_NAME/*" -d '$web'
+      - uses: actions/github-script@v6
+        if: github.event_name == 'pull_request'
+        with:
+          script: |
+            github.rest.issues.createComment({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: `This PR has been published to https://techniqueinferenceengine.z13.web.core.windows.net/${process.env['BRANCH_NAME']}/`,
+            })
+
+  github_pages:
+    # This job only runs when committing or merging to main branch.
+    if: github.ref_name == 'main'
+    needs: tie_website_build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: $\{\{ steps.deployment.outputs.page_url \}\}
+
+    steps:
+    - name: Setup Pages
+      uses: actions/configure-pages@v5
+    - name: Download Web Site
+      uses: actions/download-artifact@v4
+      with:
+        name: tie_website
+        path: tie_website
+    - name: Upload artifact
+      uses: actions/upload-pages-artifact@v3
+      with:
+        path: ./tie_website
+    - name: Deploy to GitHub Pages
+      id: deployment
+      uses: actions/deploy-pages@v4

.github/workflows/python_test.yml

@@ -0,0 +1,40 @@
+name: Python Tests
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - 'src/**'
+  pull_request:
+    paths:
+      - 'src/**'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-python@v4
+      with:
+        python-version: '3.11.8'
+    - name: Install Poetry
+      run: curl -sSL https://install.python-poetry.org/ | python -
+    - name: Add Poetry to PATH
+      run: echo "$HOME/.poetry/bin" >> $GITHUB_PATH
+    - name: Install dependencies
+      run: poetry install
+    - name: Check code formatting
+      run: poetry run ruff format --check src/
+    - name: Check imports formatting
+      run: poetry run ruff check src/
+    # - name: Check type annotations
+      # run: poetry run mypy --check src/
+    - name: Run unit tests
+      run: poetry run make test-ci
+    - name: Upload coverage to CodeCov
+      uses: codecov/codecov-action@v4
+      with:
+        token: ${{ secrets.CODECOV_SECRET }}
+        files: coverage.xml
+        verbose: true

.gitignore

@@ -0,0 +1,14 @@
+__pycache__/
+build/
+dist/
+sdist/
+*.egg-info/
+coverage.xml
+docs/_build/
+.mypy_cache/
+*.tmp
+.DS_Store
+.pre-commit-config.yaml
+.vscode/
+tests
+.github

.vscode/settings.json

@@ -0,0 +1,18 @@
+{
+    "files.insertFinalNewline": true,
+    "files.trimTrailingWhitespace": true,
+    "files.exclude": {
+        "**/__pycache__": true
+    },
+    "editor.rulers": [
+        88
+    ],
+    "python.formatting.autopep8Path": "black",
+    "markdown.extension.toc.levels": "2..6",
+    "python.formatting.provider": "black",
+    "editor.formatOnSave": true,
+    "[scss]": {
+        "editor.formatOnSave": false,
+        "editor.formatOnType": false
+    }
+}

CONTRIBUTING.md

@@ -0,0 +1,47 @@
+# Contributing
+
+## How to contribute
+
+Thanks for contributing to Technique Inference Engine!
+
+You are welcome to comment on issues, open new issues, and open pull requests.
+
+Pull requests should target the **main** branch of the repository.
+
+Also, if you contribute any source code, we need you to agree to the following
+Developer's Certificate of Origin below.
+
+## Reporting Issues
+
+* Describe (in detail) what should have happened. Include any supporting information
+  that may be helpful in resolving the issue.
+
+* Be sure to include any steps to replicate the issue.
+
+### Developer's Certificate of Origin v1.1
+
+```
+By making a contribution to this project, I certify that:
+
+(a) The contribution was created in whole or in part by me and I
+ have the right to submit it under the open source license
+ indicated in the file; or
+
+(b) The contribution is based upon previous work that, to the best
+ of my knowledge, is covered under an appropriate open source
+ license and I have the right under that license to submit that
+ work with modifications, whether created in whole or in part
+ by me, under the same open source license (unless I am
+ permitted to submit under a different license), as indicated
+ in the file; or
+
+(c) The contribution was provided directly to me by some other
+ person who certified (a), (b) or (c) and I have not modified
+ it.
+
+(d) I understand and agree that this project and the contribution
+ are public and that a record of the contribution (including all
+ personal information I submit with it, including my sign-off) is
+ maintained indefinitely and may be redistributed consistent with
+ this project or the open source license(s) involved.
+```