internal

package

v0.0.0-...-0729f85 Latest Latest Go to latest Published: Oct 28, 2023 License: Apache-2.0 Imports: 20 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/mihakralj/opnsense

Links

Open Source Insights

Documentation ¶

Rendered for

Overview ¶

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index ¶

Variables
func Checkos() (string, error)
func ConfigToJSON(doc *etree.Document, path string) string
func ConfigToTTY(doc *etree.Document, path string) string
func ConfigToXML(doc *etree.Document, path string) string
func ConfigToYAML(doc *etree.Document, path string) string
func DiffXML(oldDoc, newDoc *etree.Document, fulltree bool) *etree.Document
func EnumerateListElements(el *etree.Element)
func EnumeratePath(path string) string
func EtreeToJSON(el *etree.Element) (string, error)
func EtreeToTTY(el *etree.Element, level int, indent int) string
func ExecuteCmd(command, host string) string
func FocusEtree(doc *etree.Document, path string) *etree.Element
func FullDepth()
func GenerateBackupFilename() string
func GetSSHAgent() (ssh.AuthMethod, error)
func InjectElementAtPath(el *etree.Element, doc *etree.Document)
func LoadXMLFile(filename string, host string, canBeMissing bool) *etree.Document
func Log(verbosity int, format string, args ...interface{})
func PatchElements(patchEl *etree.Element, newDoc *etree.Document)
func PrintDocument(doc *etree.Document, path string)
func RemoveChgSpace(el *etree.Element)
func ReverseEnumerateListElements(el *etree.Element)
func ReverseEnumeratePath(path string) string
func SaveXMLFile(filename string, doc *etree.Document, host string, forced bool)
func SetFlags(v int, f bool, h string, config string, nc bool, dpt int, x bool, y bool, ...)
type SSHClient

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	SshClient *SSHClient
	SSHTarget string
)

Functions ¶

func Checkos ¶

func Checkos() (string, error)

Checkos checks that the target is an OPNsense system

func ConfigToJSON ¶

func ConfigToJSON(doc *etree.Document, path string) string

func ConfigToTTY ¶

func ConfigToTTY(doc *etree.Document, path string) string

func ConfigToXML ¶

func ConfigToXML(doc *etree.Document, path string) string

func ConfigToYAML ¶

func ConfigToYAML(doc *etree.Document, path string) string

func DiffXML ¶

func DiffXML(oldDoc, newDoc *etree.Document, fulltree bool) *etree.Document

DiffXML compares two etree documents and returns a new document with only the changed elements.

func EnumerateListElements ¶

func EnumerateListElements(el *etree.Element)

func EnumeratePath ¶

func EnumeratePath(path string) string

func EtreeToJSON ¶

func EtreeToJSON(el *etree.Element) (string, error)

func EtreeToTTY ¶

func EtreeToTTY(el *etree.Element, level int, indent int) string

EtreeToTTY returns a string representation of the etree.Element in a TTY-friendly format.

func ExecuteCmd ¶

func ExecuteCmd(command, host string) string

func FocusEtree ¶

func FocusEtree(doc *etree.Document, path string) *etree.Element

FocusEtree returns an etree.Element that represents the specified path in the document. It removes all other branches above the element that are not on the path If the path does not exist, it returns nil.

func FullDepth ¶

func FullDepth()

func GenerateBackupFilename ¶

func GenerateBackupFilename() string

func GetSSHAgent ¶

func GetSSHAgent() (ssh.AuthMethod, error)

func InjectElementAtPath ¶

func InjectElementAtPath(el *etree.Element, doc *etree.Document)

InjectElementAtPath either adds or deletes elements and attributes from the target document based on the patch instruction.

func LoadXMLFile ¶

func LoadXMLFile(filename string, host string, canBeMissing bool) *etree.Document

func Log ¶

func Log(verbosity int, format string, args ...interface{})

func PatchElements ¶

func PatchElements(patchEl *etree.Element, newDoc *etree.Document)

PatchElements processes patch instructions in an XML element to modify a target XML document.

func PrintDocument ¶

func PrintDocument(doc *etree.Document, path string)

func RemoveChgSpace ¶

func RemoveChgSpace(el *etree.Element)

func ReverseEnumerateListElements ¶

func ReverseEnumerateListElements(el *etree.Element)

func ReverseEnumeratePath ¶

func ReverseEnumeratePath(path string) string

func SaveXMLFile ¶

func SaveXMLFile(filename string, doc *etree.Document, host string, forced bool)

func SetFlags ¶

func SetFlags(v int, f bool, h string, config string, nc bool, dpt int, x bool, y bool, j bool)

Types ¶

type SSHClient ¶

type SSHClient struct {
	Session *ssh.Session
	Client  *ssh.Client
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL