Documentation ¶
Overview ¶
Package domainname implements the STIX 2.1 Domain Name SCO object.
The following information comes directly from the STIX 2.1 specification.
The Domain Name object represents the properties of a network domain name.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DomainName ¶
type DomainName struct { objects.CommonObjectProperties properties.ValueProperty properties.ResolvesToRefsProperty }
DomainName - This type implements the STIX 2 Domain Name SCO and defines
all of the properties and methods needed to create and work with this object. All of the methods not defined local to this type are inherited from the individual properties.
func Decode ¶
func Decode(data []byte) (*DomainName, error)
Decode - This function is a simple wrapper for decoding JSON data. It will
decode a slice of bytes into an actual struct and return a pointer to that object along with any errors.
func New ¶
func New() *DomainName
New - This function will create a new STIX Domain Name SCO and return it as a
pointer. It will also initialize the object by setting all of the basic properties.
func (*DomainName) Encode ¶
func (o *DomainName) Encode() ([]byte, error)
Encode - This method is a simple wrapper for encoding an object into JSON
func (*DomainName) EncodeToString ¶
func (o *DomainName) EncodeToString() (string, error)
EncodeToString - This method is a simple wrapper for encoding an object into
JSON
func (*DomainName) GetPropertyList ¶
func (o *DomainName) GetPropertyList() []string
GetProperties - This method will return a list of all of the properties that
are unique to this object. This is used by the custom UnmarshalJSON for this object. It is defined here in this file to make it easy to keep in sync.
func (*DomainName) UnmarshalJSON ¶
func (o *DomainName) UnmarshalJSON(b []byte) error
UnmarshalJSON - This method will over write the default UnmarshalJSON method
to enable custom properties that this library does not know about. It will store them as map where the value of each key is a byte arrays. This way a tool that does know how to deal with them can then further process them after this is done. This will also allow the storage of the raw JSON data.
func (*DomainName) Valid ¶
func (o *DomainName) Valid() (bool, int, []string)
Valid - This method will verify and test all of the properties on an object
to make sure they are valid per the specification. It will return a boolean, an integer that tracks the number of problems found, and a slice of strings that contain the detailed results, whether good or bad.