certificate

Documentation

Overview

Package certificate is the client.Device.CertificateProfile namespace.

For Panorama, there are three possibilities: - local to Panorama - in /config/shared - inside a template

To manage certificates on Panorama, leave "tmpl" and "ts" params empty, then either leave `dg` as an empty string (for certs in /config/panorama) or specying `dg="shared"` (for certs in /config/shared).

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

Normalized object: Entry

Index

• Constants
• type Certificate
• 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 Panorama
  • func PanoramaNamespace(client util.XapiClient) *Panorama
  • func (c *Panorama) AllFromPanosConfig(shared bool, tmpl, ts, vsys string) ([]Entry, error)
  • func (c *Panorama) Delete(shared bool, tmpl, ts, vsys string, e ...interface{}) error
  • func (c *Panorama) Edit(shared bool, tmpl, ts, vsys string, e Entry) error
  • func (c *Panorama) FromPanosConfig(shared bool, tmpl, ts, vsys, name string) (Entry, error)
  • func (c *Panorama) Get(shared bool, tmpl, ts, vsys, name string) (Entry, error)
  • func (c *Panorama) GetAll(shared bool, tmpl, ts, vsys string) ([]Entry, error)
  • func (c *Panorama) GetList(shared bool, tmpl, ts, vsys string) ([]string, error)
  • func (c *Panorama) Set(shared bool, tmpl, ts, vsys string, e ...Entry) error
  • func (c *Panorama) Show(shared bool, tmpl, ts, vsys, name string) (Entry, error)
  • func (c *Panorama) ShowAll(shared bool, tmpl, ts, vsys string) ([]Entry, error)
  • func (c *Panorama) ShowList(shared bool, tmpl, ts, vsys string) ([]string, error)

Constants

const (
	UsernameFieldSubject    = "subject"
	UsernameFieldSubjectAlt = "subject-alt"
)

Valid values for Entry.UsernameField.

const (
	UsernameFieldValueEmail         = "email"
	UsernameFieldValuePrincipalName = "principal-name"
)

Valid values for Entry.UsernameFieldValue when `UsernameField="subject-alt"`.

const (
	UsernameFieldValueCommonName = "common-name"
)

Valid values for Entry.UsernameFieldValue when `UsernameField="subject"`.

Types

type Certificate

type Certificate struct {
	Name                  string
	DefaultOcspUrl        string
	OcspVerifyCertificate string
	TemplateName          string // 9.0+
}

type Entry

type Entry struct {
	Name                            string
	UsernameField                   string
	UsernameFieldValue              string
	Domain                          string
	Certificates                    []Certificate
	UseCrl                          bool
	UseOcsp                         bool
	CrlReceiveTimeout               int
	OcspReceiveTimeout              int
	CertificateStatusTimeout        int
	BlockUnknownCertificate         bool
	BlockCertificateTimeout         bool
	BlockUnauthenticatedCertificate bool // 7.1+
	BlockExpiredCertificate         bool // 8.1+
	OcspExcludeNonce                bool // 9.0+
}

Entry is a normalized, version independent representation of a certificate profile.

Leave UsernameField as an empty string to specify a username field of `None`.

Note: Entry.CertificateStatusTimeout=0 is a valid setting, so make sure to have the desired value configured before doing Set() / Edit().

Note:

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.CertificateProfile 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 Panorama

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

Panorama is the client.Device.CertificateProfile namespace.

func PanoramaNamespace

func PanoramaNamespace(client util.XapiClient) *Panorama

PanoramaNamespace returns an initialized namespace.

func (*Panorama) AllFromPanosConfig

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

AllFromPanosConfig retrieves all objects stored in the retrieved config.

func (*Panorama) Delete

func (c *Panorama) Delete(shared bool, 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(shared bool, tmpl, ts, vsys string, e Entry) error

Edit performs EDIT to configure the specified object.

func (*Panorama) FromPanosConfig

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

FromPanosConfig retrieves the object stored in the retrieved config.

func (*Panorama) Get

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

Get performs GET to retrieve information for the given object.

func (*Panorama) GetAll

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

GetAll performs GET to retrieve all objects configured.

func (*Panorama) GetList

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

GetList performs GET to retrieve a list of all objects.

func (*Panorama) Set

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

Set performs SET to configure the specified objects.

func (*Panorama) Show

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

Show performs SHOW to retrieve information for the given object.

func (*Panorama) ShowAll

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

ShowAll performs SHOW to retrieve information for all objects.

func (*Panorama) ShowList

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

ShowList performs SHOW to retrieve a list of all objects.