mirror of
https://github.com/rapid7/metasploit-framework
synced 2024-10-29 18:07:27 +01:00
147 lines
4.7 KiB
Ruby
147 lines
4.7 KiB
Ruby
require 'swagger/blocks'
|
|
|
|
module SessionEventApiDoc
|
|
include Swagger::Blocks
|
|
|
|
SESSION_ID_DESC = 'The ID of the session record that caused this event.'
|
|
ETYPE_DESC = 'The type of session event that occurred.'
|
|
ETYPE_ENUM = ['command', 'output', 'upload', 'download', 'filedelete']
|
|
COMMAND_DESC = 'The command that was executed for this event.'
|
|
OUTPUT_DESC = 'The resulting output of the executed command.'
|
|
LOCAL_PATH_DESC = 'Path to the associated file for upload and download events.'
|
|
LOCAL_PATH_EXAMPLE = '/path/to/file'
|
|
REMOTE_PATH_DESC = 'Path to the associated file for upload, download, and filedelete events.'
|
|
REMOTE_PATH_EXAMPLE = '/path/to/file'
|
|
|
|
# Swagger documentation for session events model
|
|
swagger_schema :SessionEvent do
|
|
key :required, [:etype, :session_id]
|
|
property :id, type: :integer, format: :int32, description: RootApiDoc::ID_DESC
|
|
property :session_id, type: :integer, format: :int32, description: SESSION_ID_DESC
|
|
property :etype, type: :string, description: ETYPE_DESC, enum: ETYPE_ENUM
|
|
property :command, type: :string, description: COMMAND_DESC
|
|
property :output, type: :string, description: OUTPUT_DESC
|
|
property :local_path, type: :string, description: LOCAL_PATH_DESC, example: LOCAL_PATH_EXAMPLE
|
|
property :remote_path, type: :string, description: REMOTE_PATH_DESC, example: REMOTE_PATH_EXAMPLE
|
|
property :created_at, type: :string, format: :date_time, description: RootApiDoc::CREATED_AT_DESC
|
|
end
|
|
|
|
swagger_path '/api/v1/session-events' do
|
|
# Swagger documentation for /api/v1/session-events GET
|
|
operation :get do
|
|
key :description, 'Return session events that are stored in the database.'
|
|
key :tags, [ 'session_event' ]
|
|
|
|
response 200 do
|
|
key :description, 'Returns session event data.'
|
|
schema do
|
|
property :data do
|
|
key :type, :array
|
|
items do
|
|
key :'$ref', :SessionEvent
|
|
end
|
|
end
|
|
end
|
|
end
|
|
|
|
response 401 do
|
|
key :description, RootApiDoc::DEFAULT_RESPONSE_401
|
|
schema do
|
|
key :'$ref', :AuthErrorModel
|
|
end
|
|
end
|
|
|
|
response 500 do
|
|
key :description, RootApiDoc::DEFAULT_RESPONSE_500
|
|
schema do
|
|
key :'$ref', :ErrorModel
|
|
end
|
|
end
|
|
end
|
|
|
|
# Swagger documentation for /api/v1/session events POST
|
|
operation :post do
|
|
key :description, 'Create a session events entry.'
|
|
key :tags, [ 'session_event' ]
|
|
|
|
parameter do
|
|
key :in, :body
|
|
key :name, :body
|
|
key :description, 'The attributes to assign to the session event.'
|
|
key :required, true
|
|
schema do
|
|
property :etype, type: :string, required: true, description: ETYPE_DESC, enum: ETYPE_ENUM
|
|
property :session, '$ref' => :Session, required: true
|
|
property :command, type: :string, description: COMMAND_DESC
|
|
property :output, type: :string, description: OUTPUT_DESC
|
|
property :local_path, type: :string, description: LOCAL_PATH_DESC, example: LOCAL_PATH_EXAMPLE
|
|
property :remote_path, type: :string, description: REMOTE_PATH_DESC, example: REMOTE_PATH_EXAMPLE
|
|
end
|
|
end
|
|
|
|
response 200 do
|
|
key :description, RootApiDoc::DEFAULT_RESPONSE_200
|
|
schema do
|
|
property :data do
|
|
key :'$ref', :SessionEvent
|
|
end
|
|
end
|
|
end
|
|
|
|
response 401 do
|
|
key :description, RootApiDoc::DEFAULT_RESPONSE_401
|
|
schema do
|
|
key :'$ref', :AuthErrorModel
|
|
end
|
|
end
|
|
|
|
response 500 do
|
|
key :description, RootApiDoc::DEFAULT_RESPONSE_500
|
|
schema do
|
|
key :'$ref', :ErrorModel
|
|
end
|
|
end
|
|
end
|
|
end
|
|
|
|
swagger_path '/api/v1/session-events/{id}' do
|
|
# Swagger documentation for api/v1/session-events/:id GET
|
|
operation :get do
|
|
key :description, 'Return a specific session_event that is stored in the database.'
|
|
key :tags, [ 'session_event' ]
|
|
|
|
parameter do
|
|
key :name, :id
|
|
key :in, :path
|
|
key :description, 'ID of session_event to retrieve.'
|
|
key :required, true
|
|
key :type, :integer
|
|
key :format, :int32
|
|
end
|
|
|
|
response 200 do
|
|
key :description, 'Returns session event data.'
|
|
schema do
|
|
property :data do
|
|
key :'$ref', :SessionEvent
|
|
end
|
|
end
|
|
end
|
|
|
|
response 401 do
|
|
key :description, RootApiDoc::DEFAULT_RESPONSE_401
|
|
schema do
|
|
key :'$ref', :AuthErrorModel
|
|
end
|
|
end
|
|
|
|
response 500 do
|
|
key :description, RootApiDoc::DEFAULT_RESPONSE_500
|
|
schema do
|
|
key :'$ref', :ErrorModel
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|