openbolt 5.0.0.rc1

data/lib/bolt_server/schemas/partials/target-winrm.json

@@ -0,0 +1,67 @@
+{
+  "id": "partial:target-winrm",
+  "$schema": "http://json-schema.org/draft-04/schema",
+  "title": "Target information about where to run a bolt action over WinRM",
+  "type": "object",
+  "properties": {
+    "hostname": {
+      "type": "string",
+      "description": "Target identifier"
+    },
+    "user": {
+      "type": "string",
+      "description": "Login user"
+    },
+    "password": {
+      "type": "string",
+      "description": "Password for WinRM transport authentication"
+    },
+    "port": {
+      "type": "integer",
+      "description": "Connection port"
+    },
+    "connect-timeout": {
+      "type": "integer",
+      "description": "How long Bolt should wait when establishing connections"
+    },
+    "tmpdir": {
+      "type": "string",
+      "description": "The directory to upload and execute temporary files on the target"
+    },
+    "ssl": {
+      "type": "boolean",
+      "description": "When true, Bolt will use https connections for WinRM"
+    },
+    "ssl-verify": {
+      "type": "boolean",
+      "description": "When true, verifies the targets certificate matches the cacert"
+    },
+    "cacert": {
+      "type": "string",
+      "description": "The path to the CA certificate"
+    },
+    "extensions": {
+      "type": "array",
+      "description": "List of file extensions that are accepted for scripts or tasks"
+    },
+    "interpreters": {
+      "type": "object",
+      "description": "Map of file extensions to remote executable"
+    },
+    "file-protocol": {
+      "type": "string",
+      "enum": ["winrm", "smb"],
+      "description": "Protocol for file transfer, WinRM or SMB"
+    },
+    "smb-port": {
+      "type": "integer",
+      "description": "Port for SMB protocol"
+    },
+    "plugin_hooks": {
+      "type": "object",
+      "description": "Configuration for plugins to use"
+    }
+  },
+  "required": ["hostname", "user", "password"],
+  "additionalProperties": false
+}

data/lib/bolt_server/schemas/partials/task.json

@@ -0,0 +1,94 @@
+{
+  "id": "partial:task",
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "Task",
+  "description": "Task schema for bolt-server",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "Task name"
+    },
+    "metadata": {
+      "type": "object",
+      "description": "The metadata object is optional, and contains metadata about the task being run",
+      "properties": {
+        "description": {
+          "type": "string",
+          "description": "The task description from it's metadata"
+        },
+        "parameters": {
+          "type": "object",
+          "description": "Object whose keys are parameter names, and values are objects",
+          "properties": {
+            "description": {
+              "type": "string",
+              "description": "Parameter description"
+            },
+            "type": {
+              "type": "string",
+              "description": "The type the parameter should accept"
+            },
+            "sensitive": {
+              "description": "Whether the task runner should treat the parameter value as sensitive",
+              "type": "boolean"
+            }
+          }
+        },
+        "input_method": {
+          "type": "string",
+          "enum": ["stdin", "environment", "powershell", "both"],
+          "description": "What input method should be used to pass params to the task"
+        }
+      }
+    },
+    "files": {
+      "type": "array",
+      "description": "Description of task files",
+      "items": {
+        "type": "object",
+        "properties": {
+          "uri": {
+            "type": "object",
+            "description": "Information on how to request the file contents",
+            "properties": {
+              "path": {
+                "description": "Relative URI for accessing task contents",
+                "type": "string"
+              },
+              "params": {
+                "description": "Map of query params when requesting task content",
+                "type": "object",
+                "properties": {
+                  "environment": {
+                    "description": "Environment the task is in",
+                    "type": "string"
+                  }
+                },
+                "required": ["environment"],             
+                "additionalProperties": true
+              }
+            },
+            "required": ["path", "params"],
+            "additionalProperties": true
+          },
+          "sha256": {
+            "type": "string",
+            "description": "Checksum of file"
+          },
+          "filename": {
+            "type": "string",
+            "description": "Name of file including extension"
+          },
+          "size": {
+            "type": "number",
+            "description": "Size of file in bytes"
+          }
+        }
+      },
+      "required": ["filename", "uri", "sha256"]
+    }
+  },
+  "required": ["name", "files"],
+  "additionalProperties": true
+}

data/lib/bolt_server/schemas/transport-ssh.json

@@ -0,0 +1,25 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema",
+  "title": "Action request with SSH transport",
+  "description": "POST /ssh/<action> request schema",
+  "type": "object",
+  "properties": {
+    "target": { "$ref": "partial:target-ssh" },
+    "targets": {
+      "type": "array",
+      "items": {
+        "$ref": "partial:target-ssh"
+      }
+    }
+  },
+  "oneOf": [
+    {
+      "type": "object",
+      "required": ["target"]
+    },
+    {
+      "type": "object",
+      "required": ["targets"]
+    }
+  ]
+}

data/lib/bolt_server/schemas/transport-winrm.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema",
+  "title": "Action request with WinRM transport",
+  "description": "POST /winrm/<action> request schema",
+  "type": "object",
+  "properties": {
+    "target": { "$ref": "partial:target-winrm" },
+    "targets": {
+      "type": "array",
+      "items": {
+        "$ref": "partial:target-winrm"
+      }
+    }
+  },
+  "oneOf": [
+    { "required":  ["target"] },
+    { "required":  ["targets"] }
+  ]
+}