-
Notifications
You must be signed in to change notification settings - Fork 1
/
acme.yaml
164 lines (164 loc) · 5.54 KB
/
acme.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
---
openDxlApi: '0.1'
externalDocs:
url: https://www.opendxl.com/index.php?user/777-kaiotee/
info:
title: ACME OpenDXL Solutions
version: 1.2.3
description: Wily tools for capturing the most elusive threats.
contact:
name: Kai Otee
url: https://www.opendxl.com/index.php?user/777-kaiotee/
email: kai_otee@runningroads.com
solutions:
ACME Anvil Solution:
info:
title: ACME Anvil Solution
version: 4.5.6
description: The ACME Anvil Solution
externalDocs:
description: External product guide document for the ACME Anvil product line.
url: https://www.opendxl.com/filebase/index.php?file/999-acme-dxl-solution/
services:
- "$ref": "#/services/ACME Anvil Service"
events:
- "$ref": "#/events/~1opendxl-acme~1event~1runneralert"
- "$ref": "#/events/~1opendxl-acme~1event~1cliffalert"
- "$ref": "#/events/~1opendxl-acme~1event~1runnerfree"
services:
ACME Anvil Service:
info:
title: ACME Anvil Service
version: 7.8.9
description: A service that supports alerts and drops.
externalDocs:
description: External documentation describing design and usage of the ACME
Anvil Service.
url: https://acme.github.io/acme-anvil-service/pydoc/acme-anvil-service.html
requests:
- "$ref": "#/requests/~1opendxl-acme~1service~1anvil~1alertregister"
- "$ref": "#/requests/~1opendxl-acme~1service~1anvil~1requestdrop"
- "$ref": "#/requests/~1opendxl-acme~1service~1anvil~1requestdropencrypted"
metadata:
anvilId:
description: ID for the anvils that this service manages.
example: '12345'
anvilType:
description: Type of anvils that this service manages.
example: Solid Steel
events:
"/opendxl-acme/event/runneralert":
description: Alerts registered subscribers of a new detected Runner.
payload:
properties:
runnerID:
description: ID for the runner that triggered this alert event.
type: integer
detectTime:
description: Time at which the specified runner was detected.
type: string
format: date-time
previousCaptureAttempted:
description: Whether or not there has been an attempt to capture this runner
in the past.
type: boolean
example:
runnerID: 3
detectTime: '2018-10-12T16:39:57-08:00'
previousCaptureAttempted: true
"/opendxl-acme/event/cliffalert":
description: Alerts registered subscribers of an imminent cliff detection.
payload:
properties:
altitude:
description: Altitude of the incoming drop.
type: integer
timeUntilDetection:
description: Number of seconds until the cliff is detected.
type: integer
example:
runnerID: 3
timeUntilDetection: '2018-10-14T12:23:35-02:13'
isIncoming: false
"/opendxl-acme/event/runnerfree":
description: Incoming event notifying ACME Anvil Solution that a previously-detected
runner has been freed.
payload:
properties:
runnerID:
description: ID for the runner that has been freed.
type: integer
timeFreed:
description: Time at which the specified runner was freed.
type: string
format: date-time
example:
runnerID: 3
timeFreed: '2018-10-14T12:25:11-02:15'
isIncoming: true
requests:
"/opendxl-acme/service/anvil/alertregister":
description: Registers client GUID with ACME Anvil Service for Runner Alert events.
Empty payload, does not return a response.
payload:
"$ref": "#/definitions/alertRegisterPayload"
"/opendxl-acme/service/anvil/requestdrop":
description: Requests ACME Anvil Service data drop for the specified target file.
payload:
"$ref": "#/definitions/anvilRequestPayload"
response:
payload:
"$ref": "#/definitions/anvilResponsePayload"
errorResponses:
'1':
description: Unknown target.
payload:
properties:
detailedErrorInfo:
type: string
externalDocs:
description: 'ACME Anvil Service Wiki: Data drop values and error response codes.'
url: https://acmesolutions.com/specs/opendxl/anvil_request
"/opendxl-acme/service/anvil/requestdropencrypted":
description: Requests an encrypted ACME Anvil Service data drop for the specified
target file.
payload:
example: {}
response:
payload:
description: Raw encrypted data drop.
type: string
format: binary
otherFields:
publicKey:
description: Public key for the encrypted data drop.
required: true
example: cf23df2207d99a74fbe169e3eba035e633b65d94
definitions:
anvilRequestPayload:
type: object
properties:
targetID:
description: Target ID for file data.
type: string
example:
targetID: roadRunner.exe
anvilResponsePayload:
type: object
properties:
targetID:
description: Target ID for file data.
type: string
accuracy:
description: General measure of targeted Anvil data drop accuracy.
type: number
format: float
velocity:
description: The velocity of the target.
type: string
example:
targetID: roadRunner.exe
accuracy: 99.99
velocity: 643 kph
alertRegisterPayload:
example: {}