infosecn1nja
/
metasploit-framework
mirror of https://github.com/infosecn1nja/metasploit-framework.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add swagger docs for payloads

master
Erin Bleiweiss 2018-09-18 17:20:03 -05:00
parent dc36c3a3db
commit 102b76897c
No known key found for this signature in database
GPG Key ID: F69B2138BD594660
3 changed files with 236 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

233
documentation/api/v1/payload_api_doc.rb
View File

@ -0,0 +1,233 @@
require 'swagger/blocks'
module PayloadApiDoc
include Swagger::Blocks
NAME_DESC = 'A name for the payload'
UUID_DESC = 'A payload\'s unique identifier'
UUID_EXAMPLE = '6dde5ce0e94c9f43'
TIMESTAMP_DESC = 'The time at which the payload was generated'
TIMESTAMP_EXAMPLE = '1536777407'
ARCH_DESC = 'The architecture the payload is targeting'
ARCH_EXAMPLE = 'x86'
PLATFORM_DESC = 'The platform the payload is targeting'
PLATFORM_EXAMPLE = 'windows'
URLS_DESC = 'URLs associated with the payload'
URLS_EXAMPLE = ['/bd5c4OlMn0OeQp9AxdvC_Q2EIcdSRvg7gzLdQwU__Mb1WtjGR8C4UbjohhRIgbmBfFFBsNJ-wZMyFZKK33aorc8qfD0xCsmxSEyHaiyjGn0ykbJOlYFF1j1HXShiKiiwbfh_wPf2uqSWk2tnaLAqwuvxPcRuDPF-kdkmDDC2']
DESCRIPTION_DESC = 'A description of the payload'
WORKSPACE_ID_DESC = 'The workspace ID associated with the payload.'
WORKSPACE_ID_EXAMPLE = 'default'
# Swagger documentation for payloads model
swagger_schema :Payload do
key :required, [:ntype]
property :id, type: :integer, format: :int32, description: RootApiDoc::ID_DESC
property :name, type: :string, description: NAME_DESC
property :uuid, type: :string, description: UUID_DESC, example: UUID_EXAMPLE
property :timestamp, type: :string, description: TIMESTAMP_DESC, example: TIMESTAMP_EXAMPLE
property :arch, type: :string, description: ARCH_DESC, example: ARCH_EXAMPLE
property :platform, type: :string, description: PLATFORM_DESC, example: PLATFORM_EXAMPLE
property :urls, description: URLS_DESC, example: URLS_EXAMPLE, type: :array do items type: :string end
property :description, type: :string, description: DESCRIPTION_DESC
property :workspace_id, type: :string, description: WORKSPACE_ID_DESC, example: WORKSPACE_ID_EXAMPLE
property :created_at, type: :string, format: :date_time, description: RootApiDoc::CREATED_AT_DESC
property :updated_at, type: :string, format: :date_time, description: RootApiDoc::UPDATED_AT_DESC
end
swagger_path '/api/v1/payloads' do
# Swagger documentation for /api/v1/payloads GET
operation :get do
key :description, 'Return payloads that are stored in the database.'
key :tags, [ 'payload' ]
parameter :workspace
response 200 do
key :description, 'Returns payload data.'
schema do
property :data do
key :type, :array
items do
key :'$ref', :Payload
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/payloads POST
operation :post do
key :description, 'Create a payload entry.'
key :tags, [ 'payload' ]
parameter do
key :in, :body
key :name, :body
key :description, 'The attributes to assign to the payload.'
key :required, true
schema do
property :name, type: :string, description: NAME_DESC
property :uuid, type: :string, description: UUID_DESC, example: UUID_EXAMPLE
property :timestamp, type: :string, description: TIMESTAMP_DESC, example: TIMESTAMP_EXAMPLE
property :arch, type: :string, description: ARCH_DESC, example: ARCH_EXAMPLE
property :platform, type: :string, description: PLATFORM_DESC, example: PLATFORM_EXAMPLE
property :urls, type: :string, description: URLS_DESC, example: URLS_EXAMPLE
property :description, type: :string, description: DESCRIPTION_DESC
property :workspace_id, type: :string, description: WORKSPACE_ID_DESC, example: WORKSPACE_ID_EXAMPLE
end
end
response 200 do
key :description, RootApiDoc::DEFAULT_RESPONSE_200
schema do
property :data do
key :'$ref', :Payload
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/payloads/ DELETE
operation :delete do
key :description, 'Delete the specified payloads.'
key :tags, [ 'payload' ]
parameter :delete_opts
response 200 do
key :description, 'Returns an array containing the successfully deleted payloads.'
schema do
property :data do
key :type, :array
items do
key :'$ref', :Payload
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
end
swagger_path '/api/v1/payloads/{id}' do
# Swagger documentation for api/v1/payloads/:id GET
operation :get do
key :description, 'Return specific payload that is stored in the database.'
key :tags, [ 'payload' ]
parameter do
key :name, :id
key :in, :path
key :description, 'ID of payload to retrieve.'
key :required, true
key :type, :integer
key :format, :int32
end
response 200 do
key :description, 'Returns payload data.'
schema do
property :data do
key :'$ref', :Payload
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/payloads/:id PUT
operation :put do
key :description, 'Update the attributes an existing payload.'
key :tags, [ 'payload' ]
parameter :update_id
parameter do
key :in, :body
key :name, :body
key :description, 'The updated attributes to overwrite to the payload.'
key :required, true
schema do
key :'$ref', :Payload
end
end
response 200 do
key :description, RootApiDoc::DEFAULT_RESPONSE_200
schema do
property :data do
key :'$ref', :Payload
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

1
documentation/api/v1/root_api_doc.rb
View File

@ -63,6 +63,7 @@ module RootApiDoc
tag name: 'msf', description: 'Utility operations around Metasploit Framework.'
tag name: 'nmap', description: 'Nmap operations.'
tag name: 'note', description: 'Note operations.'
tag name: 'payload', description: 'Payload operations.'
tag name: 'service', description: 'Service operations.'
tag name: 'session', description: 'Session operations.'
tag name: 'session_event', description: 'Session Event operations.'

2
lib/msf/core/db_manager/http/servlet/api_docs_servlet.rb
View File

@ -12,6 +12,7 @@ load 'documentation/api/v1/module_search_api_doc.rb'
load 'documentation/api/v1/msf_api_doc.rb'
load 'documentation/api/v1/nmap_api_doc.rb'
load 'documentation/api/v1/note_api_doc.rb'
load 'documentation/api/v1/payload_api_doc.rb'
load 'documentation/api/v1/service_api_doc.rb'
load 'documentation/api/v1/session_api_doc.rb'
load 'documentation/api/v1/session_event_api_doc.rb'
@ -57,6 +58,7 @@ module ApiDocsServlet
MsfApiDoc,
NmapApiDoc,
NoteApiDoc,
PayloadApiDoc,
ServiceApiDoc,
SessionApiDoc,
SessionEventApiDoc,