authentication

Documentation

Overview

Package authentication is the client.Device.AuthenticationProfile namespace.

For Panorama, there are two possibilities: managing this object on Panorama itself or inside of a Template.

To manage objects save on Panorama, leave "tmpl", "ts", and "vsys" params empty.

To manage objects in a template, specify the template name and the vsys (if unspecified, defaults to "shared").

Normalized object: Entry

Index

• Constants
• type AuthenticationType
• type Entry
  • func (o *Entry) Copy(s Entry)
  • func (o Entry) Specify(v version.Number) (string, interface{})
• type Firewall
  • func FirewallNamespace(client util.XapiClient) *Firewall
  • func (c *Firewall) AllFromPanosConfig(vsys string) ([]Entry, error)
  • func (c *Firewall) Delete(vsys string, e ...interface{}) error
  • func (c *Firewall) Edit(vsys string, e Entry) error
  • func (c *Firewall) FromPanosConfig(vsys, name string) (Entry, error)
  • func (c *Firewall) Get(vsys, name string) (Entry, error)
  • func (c *Firewall) GetAll(vsys string) ([]Entry, error)
  • func (c *Firewall) GetList(vsys string) ([]string, error)
  • func (c *Firewall) Set(vsys string, e ...Entry) error
  • func (c *Firewall) Show(vsys, name string) (Entry, error)
  • func (c *Firewall) ShowAll(vsys string) ([]Entry, error)
  • func (c *Firewall) ShowList(vsys string) ([]string, error)
• type Kerberos
• type Ldap
• type MultiFactorAuthentication
• type Panorama
  • func PanoramaNamespace(client util.XapiClient) *Panorama
  • func (c *Panorama) AllFromPanosConfig(tmpl, ts, vsys string) ([]Entry, error)
  • func (c *Panorama) Delete(tmpl, ts, vsys string, e ...interface{}) error
  • func (c *Panorama) Edit(tmpl, ts, vsys string, e Entry) error
  • func (c *Panorama) FromPanosConfig(tmpl, ts, vsys, name string) (Entry, error)
  • func (c *Panorama) Get(tmpl, ts, vsys, name string) (Entry, error)
  • func (c *Panorama) GetAll(tmpl, ts, vsys string) ([]Entry, error)
  • func (c *Panorama) GetList(tmpl, ts, vsys string) ([]string, error)
  • func (c *Panorama) Set(tmpl, ts, vsys string, e ...Entry) error
  • func (c *Panorama) Show(tmpl, ts, vsys, name string) (Entry, error)
  • func (c *Panorama) ShowAll(tmpl, ts, vsys string) ([]Entry, error)
  • func (c *Panorama) ShowList(tmpl, ts, vsys string) ([]string, error)
• type Radius
• type Saml
• type SingleSignOn
• type TacacsPlus

Constants

const (
	UsernameModifierInput       = `%USERINPUT%`
	UsernameModifierInputDomain = `%USERINPUT%@%USERDOMAIN%`
	UsernameModifierDomainInput = `%USERDOMAIN%\%USERINPUT%`
)

const (
	UsernameAttributeDefault = "username"
)

Types

type AuthenticationType

type AuthenticationType struct {
	None          bool
	LocalDatabase bool
	Radius        *Radius
	Ldap          *Ldap
	Kerberos      *Kerberos
	TacacsPlus    *TacacsPlus // 7.0+
	Saml          *Saml       // 8.0+

}

type Entry

type Entry struct {
	Name                      string
	LockoutFailedAttempts     string
	LockoutTime               int
	AllowList                 []string
	Type                      AuthenticationType
	UsernameModifier          string                     // 7.0+
	UserDomain                string                     // 7.0+
	SingleSignOn              *SingleSignOn              // 7.0+
	MultiFactorAuthentication *MultiFactorAuthentication // 8.0+
}

Entry is a normalized, version independent representation of an authentication profile.

func (*Entry) Copy

func (o *Entry) Copy(s Entry)

Copy copies the information from source Entry `s` to this object. As the Name field relates to the XPATH of this object, this field is not copied.

func (Entry) Specify

func (o Entry) Specify(v version.Number) (string, interface{})

type Firewall

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

Firewall is the client.Device.AuthenticationProfile namespace.

func FirewallNamespace

func FirewallNamespace(client util.XapiClient) *Firewall

FirewallNamespace returns an initialized namespace.

func (*Firewall) AllFromPanosConfig

func (c *Firewall) AllFromPanosConfig(vsys string) ([]Entry, error)

AllFromPanosConfig retrieves all objects stored in the retrieved config.

func (*Firewall) Delete

func (c *Firewall) Delete(vsys string, e ...interface{}) error

Delete performs DELETE to remove the specified objects.

Objects can be either a string or an Entry object.

func (*Firewall) Edit

func (c *Firewall) Edit(vsys string, e Entry) error

Edit performs EDIT to configure the specified object.

func (*Firewall) FromPanosConfig

func (c *Firewall) FromPanosConfig(vsys, name string) (Entry, error)

FromPanosConfig retrieves the object stored in the retrieved config.

func (*Firewall) Get

func (c *Firewall) Get(vsys, name string) (Entry, error)

Get performs GET to retrieve information for the given object.

func (*Firewall) GetAll

func (c *Firewall) GetAll(vsys string) ([]Entry, error)

GetAll performs GET to retrieve all objects configured.

func (*Firewall) GetList

func (c *Firewall) GetList(vsys string) ([]string, error)

GetList performs GET to retrieve a list of all objects.

func (*Firewall) Set

func (c *Firewall) Set(vsys string, e ...Entry) error

Set performs SET to configure the specified objects.

func (*Firewall) Show

func (c *Firewall) Show(vsys, name string) (Entry, error)

Show performs SHOW to retrieve information for the given object.

func (*Firewall) ShowAll

func (c *Firewall) ShowAll(vsys string) ([]Entry, error)

ShowAll performs SHOW to retrieve information for all objects.

func (*Firewall) ShowList

func (c *Firewall) ShowList(vsys string) ([]string, error)

ShowList performs SHOW to retrieve a list of all objects.

type Kerberos

type Kerberos struct {
	ServerProfile string
	Realm         string // 7.0+
}

type Ldap

type Ldap struct {
	ServerProfile         string
	LoginAttribute        string
	PasswordExpiryWarning string // min 0 in pan-os 8.0+
}

type MultiFactorAuthentication

type MultiFactorAuthentication struct {
	Enabled bool
	Factors []string
}

type Panorama

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

Panorama is the client.Device.AuthenticationProfile namespace.

func PanoramaNamespace

func PanoramaNamespace(client util.XapiClient) *Panorama

PanoramaNamespace returns an initialized namespace.

func (*Panorama) AllFromPanosConfig

func (c *Panorama) AllFromPanosConfig(tmpl, ts, vsys string) ([]Entry, error)

AllFromPanosConfig retrieves all objects stored in the retrieved config.

func (*Panorama) Delete

func (c *Panorama) Delete(tmpl, ts, vsys string, e ...interface{}) error

Delete performs DELETE to remove the specified objects.

Objects can be either a string or an Entry object.

func (*Panorama) Edit

func (c *Panorama) Edit(tmpl, ts, vsys string, e Entry) error

Edit performs EDIT to configure the specified object.

func (*Panorama) FromPanosConfig

func (c *Panorama) FromPanosConfig(tmpl, ts, vsys, name string) (Entry, error)

FromPanosConfig retrieves the object stored in the retrieved config.

func (*Panorama) Get

func (c *Panorama) Get(tmpl, ts, vsys, name string) (Entry, error)

Get performs GET to retrieve information for the given object.

func (*Panorama) GetAll

func (c *Panorama) GetAll(tmpl, ts, vsys string) ([]Entry, error)

GetAll performs GET to retrieve all objects configured.

func (*Panorama) GetList

func (c *Panorama) GetList(tmpl, ts, vsys string) ([]string, error)

GetList performs GET to retrieve a list of all objects.

func (*Panorama) Set

func (c *Panorama) Set(tmpl, ts, vsys string, e ...Entry) error

Set performs SET to configure the specified objects.

func (*Panorama) Show

func (c *Panorama) Show(tmpl, ts, vsys, name string) (Entry, error)

Show performs SHOW to retrieve information for the given object.

func (*Panorama) ShowAll

func (c *Panorama) ShowAll(tmpl, ts, vsys string) ([]Entry, error)

ShowAll performs SHOW to retrieve information for all objects.

func (*Panorama) ShowList

func (c *Panorama) ShowList(tmpl, ts, vsys string) ([]string, error)

ShowList performs SHOW to retrieve a list of all objects.

type Radius

type Radius struct {
	ServerProfile     string
	RetrieveUserGroup bool // 7.0+
}

type Saml

type Saml struct {
	ServerProfile             string
	EnableSingleLogout        bool
	RequestSigningCertificate string
	CertificateProfile        string
	UsernameAttribute         string // default "username"
	UserGroupAttribute        string
	AdminRoleAttribute        string
	AccessDomainAttribute     string
}

type SingleSignOn

type SingleSignOn struct {
	Realm            string
	ServicePrincipal string
	Keytab           string // encrypted
}

type TacacsPlus

type TacacsPlus struct {
	ServerProfile     string
	RetrieveUserGroup bool // 8.0+
}