openapi

Documentation

Index

• Constants
• func GetCommonOpenApiLocations() []string
• func GetRemoteOpenApiDoc(l logger.Logger, url *url.URL) ([]byte, error)
• func TryGetOpenApiDoc(l logger.Logger, ip string, ports []int32, locations []string) (webApiDescription *discovery.WebApiDescription, err error)
• func UnMarshalOpenApiDoc(l logger.Logger, docFile []byte, uri *url.URL) (*discovery.WebApiDescription, error)

Constants

const UserAgent = "cnfuzz"

Functions

func GetCommonOpenApiLocations

func GetCommonOpenApiLocations() []string

GetCommonOpenApiLocations returns a list of locations commonly used for OpenAPI specifications in web API's

func GetRemoteOpenApiDoc

func GetRemoteOpenApiDoc(l logger.Logger, url *url.URL) ([]byte, error)

GetRemoteOpenApiDoc get OpenApi doc from a URL Use this method if the full URL to the OpenApi doc is known

func TryGetOpenApiDoc

func TryGetOpenApiDoc(l logger.Logger, ip string, ports []int32, locations []string) (webApiDescription *discovery.WebApiDescription, err error)

TryGetOpenApiDoc try getting the OpenApi doc from a host without knowing the exact OpenApi doc location

func UnMarshalOpenApiDoc

func UnMarshalOpenApiDoc(l logger.Logger, docFile []byte, uri *url.URL) (*discovery.WebApiDescription, error)

UnMarshalOpenApiDoc unmarshal OpenAPI doc represented as a byte array returns a WebApiDescription object that represents the OpenAPI document