taxii

Documentation

Index

• Constants
• type APIRootResource
• type Collection
  • func ImplementedCollections() []Collection
• type DiscoveryResource
• type Envelope

Constants

const (
	// APIRoot is the part of the URL that makes up the TAXII API root.
	APIRoot = "/taxii2/api/"

	// ContentType is the `Content-Type` HTTP response header used when
	// returning TAXII responses.
	ContentType = "application/taxii+json;version=2.1"

	// IndicatorsID is a fixed (random) identifier for the indicators
	// collection.
	IndicatorsID = "2cc72f88-8d92-4745-9c00-ea0deac18163"

	// IndicatorsAlias is the friendly alias for the indicators collection.
	IndicatorsAlias = "deceptifeed-indicators"

	// ObservablesID is a fixed (random) identifier for the observables
	// collection.
	ObservablesID = "8aaff655-40de-41e2-9064-3dc1620d6420"

	// ObservablesAlias is the friendly alias for the observables collection.
	ObservablesAlias = "deceptifeed-observables"
)

Types

type APIRootResource

type APIRootResource struct {
	Title            string   `json:"title"`              // Required
	Versions         []string `json:"versions"`           // Required
	MaxContentLength int      `json:"max_content_length"` // Required
}

APIRootResource represents a TAXII api-root resource, which contains general information about the API root.

type Collection

type Collection struct {
	ID          string   `json:"id"`                    // Required
	Title       string   `json:"title"`                 // Required
	Description string   `json:"description,omitempty"` // Optional
	Alias       string   `json:"alias,omitempty"`       // Optional
	CanRead     bool     `json:"can_read"`              // Required
	CanWrite    bool     `json:"can_write"`             // Required
	MediaTypes  []string `json:"media_types,omitempty"` // Optional
}

Collection represents a TAXII collection resource, which contains general information about a collection.

func ImplementedCollections

func ImplementedCollections() []Collection

ImplementedCollections returns the collections that are available for use.

type DiscoveryResource

type DiscoveryResource struct {
	Title       string   `json:"title"`                 // Required
	Description string   `json:"description,omitempty"` // Optional
	Default     string   `json:"default,omitempty"`     // Optional
	APIRoots    []string `json:"api_roots,omitempty"`   // Optional
}

DiscoveryResource represents a TAXII discovery resource, which contains information about a TAXII server.

type Envelope

type Envelope struct {
	More    bool          `json:"more"`           // Optional
	Next    string        `json:"next,omitempty"` // Optional
	Objects []stix.Object `json:"objects"`        // Optional
}

Envelope represents a TAXII envelope resource, which is a simple wrapper for STIX 2 content.