Initial commit

.github/workflows/release.yaml

@@ -0,0 +1,24 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - v*.*.*
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Install dependencies
+        run: composer install
+
+      - name: Compile package
+        run: vendor/bin/box compile
+
+      - name: Release
+        uses: softprops/action-gh-release@v1
+        with:
+          files: dist/auth-vatsim.phar

.gitignore

@@ -0,0 +1,3 @@
+/dist
+/vendor-bin/*/vendor
+/vendor

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) VATSIM Inc.
+
+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.

README.md

@@ -0,0 +1,21 @@
+# VATSIM Connect Authentication for osTicket
+
+## Installation
+
+Download `auth-vatsim.phar` from the
+[latest release](https://github.com/vatsimnetwork/osticket-auth-vatsim/releases/latest)
+and place it in the `include/plugins` folder in your osTicket installation.
+
+Sign into your osTicket staff control panel, enable the plugin, and create a
+plugin instance. You'll then be able to configure the plugin.
+
+## Configuration
+
+You'll need to add a new client to your organization in Connect. For more
+information on this process, [please see here](https://vatsim.dev/services/connect/)
+
+For the Redirect URL, specify `https://<hostname>/api/auth/ext`.
+
+* **Client ID**: Your application's Client ID from auth.vatsim.net.
+* **Client Secret**: Your application's Client Secret from auth.vatsim.net.
+* **Authentication**: Whether to use VATSIM auth for clients, staff, both, or none.

bootstrap.php

@@ -0,0 +1,3 @@
+<?php
+
+require __DIR__.'/vendor/autoload.php';

box.json.dist

@@ -0,0 +1,34 @@
+{
+    "main": false,
+    "output": "dist/auth-vatsim.phar",
+    "chmod": "0644",
+    "check-requirements": false,
+    "files": [
+        "bootstrap.php",
+        "plugin.php"
+    ],
+    "shebang": false,
+    "banner": [
+        "VATSIM Connect Authentication for osTicket",
+        "",
+        "Copyright (c) VATSIM Inc.",
+        "",
+        "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."
+    ]
+}

composer.json

@@ -0,0 +1,36 @@
+{
+    "name": "vatsim/osticket-auth-vatsim",
+    "description": "osTicket plugin for authenticating users via VATSIM Connect",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "William McKinnerney",
+            "email": "[email protected]",
+            "homepage": "https://williammck.net"
+        }
+    ],
+    "minimum-stability": "stable",
+    "require": {
+        "php": "^8.0",
+        "vatsim/oauth2-vatsim": "^1.0"
+    },
+    "require-dev": {
+        "bamarni/composer-bin-plugin": "^1.8"
+    },
+    "autoload": {
+        "psr-4": {
+            "Vatsim\\Osticket\\Auth\\": "src/"
+        }
+    },
+    "extra": {
+        "bamarni-bin": {
+            "bin-links": true,
+            "forward-command": true
+        }
+    },
+    "config": {
+        "allow-plugins": {
+            "bamarni/composer-bin-plugin": true
+        }
+    }
+}