ieee8021x

Documentation

Overview

********************************************************************

• Copyright (c) Intel Corporation 2023
• SPDX-License-Identifier: Apache-2.0 *********************************************************************

Package 8021xCredentialContext facilitates communication with Intel® AMT devices to create an association between an instance of IPS_IEEE8021xSettings and an instance of AMT_PublicKeyCertificate that it uses.

Index

• Constants
• type Body
• type Certificate
• type ClientCertificateIssuer
• type CredentialContext
  • func NewIEEE8021xCredentialContextWithClient(wsmanMessageCreator *message.WSManMessageCreator, client client.WSMan) CredentialContext
  • func (credentialContext CredentialContext) Enumerate() (response Response, err error)
  • func (credentialContext CredentialContext) Get() (response Response, err error)
  • func (credentialContext CredentialContext) Pull(enumerationContext string) (response Response, err error)
• type CredentialContextResponse
• type ElementInContextResponse
• type ElementProvidingContextResponse
• type Enabled
  • func (e Enabled) String() string
• type IEEE8021xSettingsRequest
• type IEEE8021xSettingsResponse
• type PullResponse
• type ReferenceParameters
• type ReferenceParametersResponse
• type Response
  • func (r *Response) JSON() string
  • func (r *Response) YAML() string
• type ReturnValue
  • func (r ReturnValue) String() string
• type Selector
• type SelectorResponse
• type SelectorSet
• type SelectorSetResponse
• type ServerCertificateIssuer
• type SetCertificates_OUTPUT
• type Settings
  • func NewIEEE8021xSettingsWithClient(wsmanMessageCreator *message.WSManMessageCreator, client client.WSMan) Settings
  • func (settings Settings) Enumerate() (response Response, err error)
  • func (settings Settings) Get() (response Response, err error)
  • func (settings Settings) Pull(enumerationContext string) (response Response, err error)
  • func (settings Settings) Put(ieee8021xSettings IEEE8021xSettingsRequest) (response Response, err error)
  • func (settings Settings) SetCertificates(serverCertificateIssuer, clientCertificate string) (response Response, err error)

Constants

const (
	IPSIEEE8021xSettings      string = "IPS_IEEE8021xSettings"
	IPS8021xCredentialContext string = "IPS_8021xCredentialContext"
	SetCertificates           string = "SetCertificates"
	ValueNotFound             string = "Value not found in map"
)

const (
	AuthenticationProtocolEAPTLS int = iota
	AuthenticationProtocolEAPTTLS_MSCHAPv2
	AuthenticationProtocolPEAPv0_EAPMSCHAPv2
	AuthenticationProtocolPEAPv1_EAPGTC
	AuthenticationProtocolEAPFAST_MSCHAPv2
	AuthenticationProtocolEAPFAST_GTC
	AuthenticationProtocolEAP_MD5
	AuthenticationProtocolEAP_PSK
	AuthenticationProtocolEAP_SIM
	AuthenticationProtocolEAP_AKA
	AuthenticationProtocolEAPFAST_TLS
)

Types

type Body

type Body struct {
	XMLName                   xml.Name `xml:"Body"`
	PullResponse              PullResponse
	EnumerateResponse         common.EnumerateResponse
	IEEE8021xSettingsResponse IEEE8021xSettingsResponse
	SetCertificatesResponse   SetCertificates_OUTPUT
}

OUTPUT Response Types.

type Certificate

type Certificate struct {
	XMLName                 xml.Name `xml:"h:SetCertificates_INPUT"`
	H                       string   `xml:"xmlns:h,attr"`
	ServerCertificateIssuer ServerCertificateIssuer
	ClientCertificate       ClientCertificateIssuer
}

INPUT Request Types.

type ClientCertificateIssuer

type ClientCertificateIssuer struct {
	XMLName             xml.Name            `xml:"h:ClientCertificate"`
	Address             string              `xml:"a:Address"`
	ReferenceParameters ReferenceParameters `xml:"a:ReferenceParameters"`
}

INPUT Request Types.

type CredentialContext

type CredentialContext struct {
	// contains filtered or unexported fields
}

Package Types.

func NewIEEE8021xCredentialContextWithClient

func NewIEEE8021xCredentialContextWithClient(wsmanMessageCreator *message.WSManMessageCreator, client client.WSMan) CredentialContext

NewIEEE8021xCredentialContext returns a new instance of the IPS_8021xCredentialContext struct.

func (CredentialContext) Enumerate

func (credentialContext CredentialContext) Enumerate() (response Response, err error)

Enumerate returns an enumeration context which is used in a subsequent Pull call.

func (CredentialContext) Get

func (credentialContext CredentialContext) Get() (response Response, err error)

Get retrieves the representation of the instance.

func (CredentialContext) Pull

func (credentialContext CredentialContext) Pull(enumerationContext string) (response Response, err error)

Pull returns the instances of this class. An enumeration context provided by the Enumerate call is used as input.

type CredentialContextResponse

type CredentialContextResponse struct {
	XMLName                 xml.Name                        `xml:"IPS_8021xCredentialContext"`
	ElementInContext        ElementInContextResponse        `xml:"ElementInContext"`
	ElementProvidingContext ElementProvidingContextResponse `xml:"ElementProvidingContext"`
}

OUTPUT Response Types.

type ElementInContextResponse

type ElementInContextResponse struct {
	XMLName             xml.Name                    `xml:"ElementInContext"`
	Address             string                      `xml:"Address,omitempty"`
	ReferenceParameters ReferenceParametersResponse `xml:"ReferenceParameters,omitempty"`
}

OUTPUT Response Types.

type ElementProvidingContextResponse

type ElementProvidingContextResponse struct {
	XMLName             xml.Name                    `xml:"ElementProvidingContext"`
	Address             string                      `xml:"Address,omitempty"`
	ReferenceParameters ReferenceParametersResponse `xml:"ReferenceParameters,omitempty"`
}

OUTPUT Response Types.

type Enabled

type Enabled int

Enabled indicates whether the IEEE 802.1x settings are enabled or disabled.

const (
	EnabledWithCertificates    Enabled = 2
	Disabled                   Enabled = 3
	EnabledWithoutCertificates Enabled = 6
)

func (Enabled) String

func (e Enabled) String() string

String returns a human-readable string representation of the Enabled enumeration.

type IEEE8021xSettingsRequest

type IEEE8021xSettingsRequest struct {
	XMLName                         xml.Name `xml:"h:IPS_IEEE8021xSettings,omitempty"`
	H                               string   `xml:"xmlns:h,attr"`
	ElementName                     string   `xml:"h:ElementName,omitempty"`
	InstanceID                      string   `xml:"h:InstanceID,omitempty"`
	AuthenticationProtocol          int      `xml:"h:AuthenticationProtocol"`
	RoamingIdentity                 string   `xml:"h:RoamingIdentity,omitempty"`
	ServerCertificateName           string   `xml:"h:ServerCertificateName,omitempty"`
	ServerCertificateNameComparison int      `xml:"h:ServerCertificateNameComparison,omitempty"`
	Username                        string   `xml:"h:Username,omitempty"`
	Password                        string   `xml:"h:Password,omitempty"`
	Domain                          string   `xml:"h:Domain,omitempty"`
	ProtectedAccessCredential       string   `xml:"h:ProtectedAccessCredential,omitempty"`
	PACPassword                     string   `xml:"h:PACPassword,omitempty"`
	PSK                             string   `xml:"h:PSK,omitempty"`
	Enabled                         int      `xml:"h:Enabled,omitempty"`
	PxeTimeout                      int      `xml:"h:PxeTimeout,omitempty"`
	AvailableInS0                   bool     `xml:"h:AvailableInS0,omitempty"`
}

INPUT Request Types.

type IEEE8021xSettingsResponse

type IEEE8021xSettingsResponse struct {
	XMLName       xml.Name `xml:"IPS_IEEE8021xSettings"`
	ElementName   string   `xml:"ElementName"`
	InstanceID    string   `xml:"InstanceID"`
	Enabled       Enabled  `xml:"Enabled"`
	AvailableInS0 bool     `xml:"AvailableInS0"`
	PxeTimeout    int      `xml:"PxeTimeout"`
}

OUTPUT Response Types.

type PullResponse

type PullResponse struct {
	XMLName                xml.Name                    `xml:"PullResponse"`
	IEEE8021xSettingsItems []IEEE8021xSettingsResponse `xml:"Items>IPS_IEEE8021xSettings"`
	CredentialContextItems []CredentialContextResponse `xml:"Items>IPS_8021xCredentialContext"`
}

OUTPUT Response Types.

type ReferenceParameters

type ReferenceParameters struct {
	XMLName     xml.Name    `xml:"a:ReferenceParameters"`
	ResourceURI string      `xml:"w:ResourceURI"`
	SelectorSet SelectorSet `xml:"w:SelectorSet"`
}

INPUT Request Types.

type ReferenceParametersResponse

type ReferenceParametersResponse struct {
	XMLName     xml.Name            `xml:"ReferenceParameters,omitempty"`
	ResourceURI string              `xml:"ResourceURI,omitempty"`
	SelectorSet SelectorSetResponse `xml:"SelectorSet,omitempty"`
}

OUTPUT Response Types.

type Response

type Response struct {
	*client.Message
	XMLName xml.Name       `xml:"Envelope"`
	Header  message.Header `xml:"Header"`
	Body    Body           `xml:"Body"`
}

OUTPUT Response Types.

func (*Response) JSON

func (r *Response) JSON() string

JSON marshals the type into JSON format.

func (*Response) YAML

func (r *Response) YAML() string

YAML marshals the type into YAML format.

type ReturnValue

type ReturnValue int

ReturnValue indicates the status of the operation.

const (
	ReturnValueSuccess ReturnValue = iota
	ReturnValueInternalError
)

func (ReturnValue) String

func (r ReturnValue) String() string

String returns a human-readable string representation of the ReturnValue enumeration.

type Selector

type Selector struct {
	XMLName xml.Name `xml:"w:Selector"`
	Name    string   `xml:"Name,attr"`
	Value   string   `xml:",chardata"`
}

INPUT Request Types.

type SelectorResponse

type SelectorResponse struct {
	XMLName xml.Name `xml:"Selector,omitempty"`
	Name    string   `xml:"Name,attr"`
	Text    string   `xml:",chardata"`
}

OUTPUT Response Types.

type SelectorSet

type SelectorSet struct {
	XMLName  xml.Name `xml:"w:SelectorSet"`
	Selector Selector `xml:"w:Selector"`
}

INPUT Request Types.

type SelectorSetResponse

type SelectorSetResponse struct {
	XMLName   xml.Name           `xml:"SelectorSet,omitempty"`
	Selectors []SelectorResponse `xml:"Selector,omitempty"`
}

OUTPUT Response Types.

type ServerCertificateIssuer

type ServerCertificateIssuer struct {
	XMLName             xml.Name            `xml:"h:ServerCertificateIssuer"`
	Address             string              `xml:"a:Address"`
	ReferenceParameters ReferenceParameters `xml:"a:ReferenceParameters"`
}

INPUT Request Types.

type SetCertificates_OUTPUT

type SetCertificates_OUTPUT struct {
	XMLName     xml.Name `xml:"SetCertificates_OUTPUT"`
	ReturnValue ReturnValue
}

OUTPUT Response Types.

type Settings

type Settings struct {
	// contains filtered or unexported fields
}

Package Types.

func NewIEEE8021xSettingsWithClient

func NewIEEE8021xSettingsWithClient(wsmanMessageCreator *message.WSManMessageCreator, client client.WSMan) Settings

NewIEEE8021xSettings returns a new instance of the IEEE8021xSettings struct.

func (Settings) Enumerate

func (settings Settings) Enumerate() (response Response, err error)

Enumerate returns an enumeration context which is used in a subsequent Pull call.

func (Settings) Get

func (settings Settings) Get() (response Response, err error)

Get retrieves the representation of the instance.

func (Settings) Pull

func (settings Settings) Pull(enumerationContext string) (response Response, err error)

Pull returns the instances of this class. An enumeration context provided by the Enumerate call is used as input.

func (Settings) Put

func (settings Settings) Put(ieee8021xSettings IEEE8021xSettingsRequest) (response Response, err error)

Put will change properties of the selected instance.

func (Settings) SetCertificates

func (settings Settings) SetCertificates(serverCertificateIssuer, clientCertificate string) (response Response, err error)