Govici

https://pkg.go.dev/github.com/strongswan/govici
Admin
Govici is a pure-Go implementation of a vici protocol client library for monitoring, configuring,...
Tokens:9,647
Snippets:102
Trust Score:9.6
Update:5 months ago
Show doc for...
Tokens:
Raw
### Import VICI Package

Source: https://pkg.go.dev/github.com/strongswan/govici

Import the necessary VICI package to start using the client library.

```go
import (
        "github.com/strongswan/govici/vici"
)
```

--------------------------------

### Create a New VICI Message

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

Instantiate an empty VICI Message object using NewMessage. This provides a starting point for building request messages.

```go
func NewMessage() *Message
```

--------------------------------

### Get String Representation of VICI Message

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

Convert a VICI Message into its string format, suitable for display or logging, using the String method. The output resembles the swanctl.conf configuration format.

```go
func (m *Message) String() string
```

--------------------------------

### CommandRequest: Send a command request and get response

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

CommandRequest sends a command to the server and returns its response. Use the Call method instead, as CommandRequest is deprecated. Errors during communication return a nil Message and a non-nil error.

```go
func (s *Session) CommandRequest(cmd string, msg *Message) (*Message, error)
```

--------------------------------

### Message.Get

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

Get retrieves the value of a field from a Vici Message by its key. It returns the internal message representation (string, []string, or *Message) or nil if the key does not exist.

```APIDOC
## func (*Message) Get

### Description
Get returns the value of the field identified by key, if it exists. If the field does not exist, nil is returned. The value returned by Get is the internal message representation of that field, which means the type is either string, []string, or *Message.

```

--------------------------------

### Retrieve a Value from a VICI Message

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

Access specific fields within a VICI Message using the Get method. Returns the internal representation (string, []string, or *Message) or nil if the key does not exist.

```go
func (m *Message) Get(key string) any
```

--------------------------------

### Specify VICI Socket Path Option

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

Use WithSocketPath to specify the path of the socket charon is listening on. If not specified, the default path /var/run/charon.vici is used.

```go
func WithSocketPath(path string) SessionOption
```

--------------------------------

### Create a New VICI Session

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

Establish a new client session with the VICI daemon using NewSession. Optional SessionOptions can be provided to configure the session.

```go
func NewSession(opts ...SessionOption) (*Session, error)
```

--------------------------------

### WithSocketPath

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

Specifies the path of the socket that charon is listening on. If this option is not specified, the default path, /var/run/charon.vici, is used.

```APIDOC
## func WithSocketPath ¶ added in v0.2.0

```
func WithSocketPath(path string) SessionOption
```

### Description
WithSocketPath specifies the path of the socket that charon is listening on. If this option is not specified, the default path, /var/run/charon.vici, is used.

### Parameters
#### Path Parameters
- **path** (string) - Required - The path to the VICI socket.
```

--------------------------------

### NewSession

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

NewSession establishes and returns a new Vici client session, optionally configured with provided SessionOptions.

```APIDOC
## func NewSession

### Description
NewSession returns a new vici session.

```

--------------------------------

### SessionOption Functions

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

Functions to configure Session creation.

```APIDOC
## type SessionOption

### Functions
#### func WithAddr(network, addr string) SessionOption
Creates a SessionOption to specify the network address for the VICI connection.

#### func WithDialContext(dialer func(ctx context.Context, network, addr string) (net.Conn, error)) SessionOption
Creates a SessionOption to provide a custom dialer function.

#### func WithSocketPath(path string) SessionOption
Creates a SessionOption to specify the path to the VICI Unix domain socket.
```

--------------------------------

### Message.String

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

String returns a string representation of the Vici Message, formatted similarly to the swanctl.conf configuration file for readability.

```APIDOC
## func (*Message) String

### Description
String returns the string form of m. For readability, the output format is similar to swanctl.conf configuration format.

```

--------------------------------

### WithAddr

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

Specifies the network and address of the socket that charon is listening on. If not specified, the default path /var/run/charon.vici is used.

```APIDOC
## WithAddr

### Description
WithAddr specifies the network and address of the socket that charon is listening on. If this option is not specified, the default path, /var/run/charon.vici, is used. As the protocol itself currently does not provide any security or authentication properties, it is recommended to run it over a UNIX socket with appropriate permissions.

### Signature
```go
func WithAddr(network, addr string) SessionOption
```
```

--------------------------------

### Session.Call

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

Invokes a client-initiated command on the charon daemon. The command is identified by its name, and an optional message containing IN parameters can be provided. The method returns a Message containing the OUT parameters.

```APIDOC
## Session.Call

### Description
Invokes a client-initiated command on the charon daemon. The command is identified by its name, and an optional message containing IN parameters can be provided. The method returns a Message containing the OUT parameters.

### Method
`Call(ctx context.Context, cmd string, msg *Message) (*Message, error)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **cmd** (string) - Required - The name of the command to invoke.
- **msg** (*Message) - Optional - A Message containing the IN parameters for the command. Can be nil if no IN parameters are required.

### Request Example
```go
// Example of calling a command with no IN parameters
response, err := session.Call(ctx, "reload-settings", nil)

// Example of calling a command with IN parameters
// Assuming 'requestMsg' is a *vici.Message with appropriate fields
response, err := session.Call(ctx, "some-command", requestMsg)
```

### Response
#### Success Response (200)
- **(*Message)** - A Message containing the OUT parameters of the command.

#### Response Example
```go
// Assuming 'response' is the *vici.Message returned by Session.Call
// You can unmarshal it into a struct or access fields directly
```
```

--------------------------------

### CallStreaming: Make a streaming command request

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

Use CallStreaming for commands that involve streaming events until completion. Ensure the context is non-nil for interrupting I/O. Errors during initial request or event registration return a non-nil error without response messages.

```go
func (s *Session) CallStreaming(ctx context.Context, cmd string, event string, in *Message) iter.Seq2[*Message, error]
```

--------------------------------

### Register for Event Notifications

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

Register a channel with NotifyEvents to receive server-issued events. The channel will be populated with incoming event messages.

```go
func (s *Session) NotifyEvents(ch chan<- *Message)
```

--------------------------------

### Call VICI Command

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

Execute a command on the VICI server via an active session using the Call method. It sends a command string and an input Message, returning the server's response Message and any errors.

```go
func (s *Session) Call(ctx context.Context, cmd string, in *Message) (*Message, error)
```

--------------------------------

### Session Type

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

The Session type provides methods for interacting with the strongSwan VICI daemon, including sending commands and subscribing to events.

```APIDOC
## type Session

### Methods
#### func NewSession(opts ...SessionOption) (*Session, error)
Creates a new Session with the provided options.

#### func (s *Session) Call(ctx context.Context, cmd string, in *Message) (*Message, error)
Sends a command to the VICI daemon and waits for a response.

#### func (s *Session) CallStreaming(ctx context.Context, cmd string, event string, in *Message) iter.Seq2[*Message, error]
Sends a command to the VICI daemon and returns a stream of messages.

#### func (s *Session) Close() error
Closes the VICI session.

#### func (s *Session) CommandRequest(cmd string, msg *Message) (*Message, error)
Sends a command to the VICI daemon. Deprecated: Use Call instead.

#### func (s *Session) NotifyEvents(c chan<- Event)
Starts receiving events on the provided channel.

#### func (s *Session) StopEvents(c chan<- Event)
Stops receiving events on the provided channel.

#### func (s *Session) StreamedCommandRequest(cmd string, event string, msg *Message) ([]*Message, error)
Sends a command to the VICI daemon and returns a slice of messages. Deprecated: Use CallStreaming instead.

#### func (s *Session) Subscribe(events ...string) error
Subscribes to one or more event types.

#### func (s *Session) Unsubscribe(events ...string) error
Unsubscribes from one or more event types.

#### func (s *Session) UnsubscribeAll() error
Unsubscribes from all event types.
```

--------------------------------

### Session.Call

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

Call sends a command request to the Vici server with the specified command and arguments. It returns the server's response Message or an error if communication fails or the command execution results in an error.

```APIDOC
## func (*Session) Call

### Description
Call makes a command request to the server, and returns the server's response. The command is specified by cmd, and its arguments are provided by in. If there is an error communicating with the daemon, a nil Message and non-nil error are returned. If the command fails, the response Message is returned along with the error returned by Message.Err. The provided context must be non-nil, and can be used to interrupt blocking network I/O involved in the command request.

```

--------------------------------

### Call VICI Command with No Input

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

Invoke a VICI command that requires no input parameters by passing nil for the message argument. The returned Message contains the command's output.

```go
func (s *Session) Call(ctx context.Context, cmd string, msg *Message) (*Message, error)
```

--------------------------------

### Session.CommandRequest

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

Sends a command request to the server and returns the server's response. Deprecated: Use the Call method instead.

```APIDOC
## Session.CommandRequest

### Description
CommandRequest sends a command request to the server, and returns the server's response. The command is specified by cmd, and its arguments are provided by msg. If there is an error communicating with the daemon, a nil Message and non-nil error are returned. If the command fails, the response Message is returned along with the error returned by Message.Err.

### Deprecation
Deprecated: Use the Call method instead. CommandRequest will be removed in a future version.

### Signature
```go
func (s *Session) CommandRequest(cmd string, msg *Message) (*Message, error)
```
```

--------------------------------

### SessionOption interface

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

SessionOption is an interface used to configure additional options when creating a Vici session. It is typically implemented by functions like WithAddr and WithDialContext.

```go
type SessionOption interface {
	// contains filtered or unexported methods
}
```

--------------------------------

### WithAddr: Specify socket network and address

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

WithAddr sets the network and address for the charon socket. If not provided, it defaults to /var/run/charon.vici. It's recommended to use UNIX sockets for security.

```go
func WithAddr(network, addr string) SessionOption
```

--------------------------------

### Session.Subscribe

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

Registers the session to listen for all specified events. Use NotifyEvents to receive these events.

```APIDOC
## Session.Subscribe

### Description
Subscribe registers the session to listen for all events given. To receive events that are registered here, use NotifyEvents. An error is returned if Subscribe is not able to register the given events with the charon daemon.

### Signature
```go
func (s *Session) Subscribe(events ...string) error
```
```

--------------------------------

### List Keys in a VICI Message

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

Obtain a list of all available keys within a VICI Message using the Keys method. This is useful for iterating over message fields.

```go
func (m *Message) Keys() []string
```

--------------------------------

### WithDialContext

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

Specifies the dial function to use when dialing the charon socket.

```APIDOC
## WithDialContext

### Description
WithDialContext specifies the dial func to use when dialing the charon socket.

### Signature
```go
func WithDialContext(dialer func(ctx context.Context, network, addr string) (net.Conn, error)) SessionOption
```
```

--------------------------------

### NewMessage

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

NewMessage creates and returns an empty Vici Message object.

```APIDOC
## func NewMessage

### Description
NewMessage returns an empty Message.

```

--------------------------------

### WithDialContext: Specify custom dial function

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

WithDialContext allows providing a custom dial function for establishing the connection to the charon socket. This offers flexibility in connection management.

```go
func WithDialContext(dialer func(ctx context.Context, network, addr string) (net.Conn, error)) SessionOption
```

--------------------------------

### Message.Keys

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

Keys returns a slice of strings representing all valid keys present in the Vici Message.

```APIDOC
## func (*Message) Keys

### Description
Keys returns the list of valid message keys.

```

--------------------------------

### Subscribe to Server-Issued Events

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

Subscribe to server-issued events like 'ike-updown' or 'child-updown' using the Subscribe method. Multiple event types can be subscribed to in a single call.

```go
func (s *Session) Subscribe(events ...string) error
```

--------------------------------

### Session.Subscribe

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

Subscribes the client to one or more server-issued events. The client will then receive notifications for these events.

```APIDOC
## Session.Subscribe

### Description
Subscribes the client to one or more server-issued events. The client will then receive notifications for these events.

### Method
`Subscribe(ctx context.Context, events ...string) error`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **events** ([]string) - Required - A variadic list of event names to subscribe to.

### Request Example
```go
// Subscribe to 'ike-updown' and 'child-updown' events
err := session.Subscribe(ctx, "ike-updown", "child-updown")
if err != nil {
    // Handle error
}
```

### Response
#### Success Response (200)
- **(nil)** - Indicates successful subscription.

#### Response Example
```go
// No specific response body for success, check for error.
```
```

--------------------------------

### Session.CallStreaming

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

Makes a command request to the server which involves streaming a given event type until the command is complete. Returns an iterator for response messages and errors.

```APIDOC
## Session.CallStreaming

### Description
Makes a command request to the server which involves streaming a given event type until the command is complete. The command and event names are specified with cmd and event, and the command arguments are provided by in. If there is an error during the initial command request or event registration, no response messages are returned and a non-nil error is returned. When the initial command request and event registration are successful, an iterator is returned which will yield response messages, and possibly errors, as they are received from the server. The provided context must be non-nil, and can be used to interrupt blocking network I/O involved in the command request.

### Signature
```go
func (s *Session) CallStreaming(ctx context.Context, cmd string, event string, in *Message) iter.Seq2[*Message, error]
```
```

--------------------------------

### Session.StreamedCommandRequest

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

Sends a streamed command request to the server, accepting an event argument to stream while the command is active. Deprecated: Use the CallStreaming method instead.

```APIDOC
## Session.StreamedCommandRequest

### Description
StreamedCommandRequest sends a streamed command request to the server. StreamedCommandRequest behaves like CommandRequest, but accepts an event argument, which specifies the event type to stream while the command request is active. The complete stream of messages received from the server is returned once the request is complete.

### Deprecation
Deprecated: Use the CallStreaming method instead. StreamedCommandRequest will be removed in a future version.

### Signature
```go
func (s *Session) StreamedCommandRequest(cmd string, event string, msg *Message) ([]*Message, error)
```
```

--------------------------------

### Call Streaming VICI Command

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

Use CallStreaming for commands that emit events while active, such as 'list-sas'. It returns an iterator yielding [*Message, error] pairs for each streamed event.

```go
func (s *Session) CallStreaming(ctx context.Context, cmd string, event string, msg *Message) (<-chan *Message, error)
```

--------------------------------

### Define Vici Event Structure

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

Represents an event received from the charon daemon. Includes the event name, associated message, and timestamp.

```go
type Event struct {
	// Name is the event type name as specified by the
	// charon server, such as "ike-updown" or "log".
	Name string

	// Message is the Message associated with this event.
	Message *Message

	// Timestamp holds the timestamp of when the client
	// received the event.
	Timestamp time.Time
}
```

--------------------------------

### MarshalMessage and UnmarshalMessage

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

Functions for marshalling Go structs to VICI Message format and unmarshalling VICI Messages back into Go structs. These are convenient for managing complex VICI message data.

```APIDOC
## MarshalMessage and UnmarshalMessage

### Description
Functions for marshalling Go structs to VICI Message format and unmarshalling VICI Messages back into Go structs. These are convenient for managing complex VICI message data.

### Method
`MarshalMessage(v interface{}) (*Message, error)`
`UnmarshalMessage(msg *Message, v interface{}) error`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **v** (interface{}) - Required - The Go struct to marshal or unmarshal.
- **msg** (*Message) - Required for UnmarshalMessage - The VICI Message to unmarshal from.

### Request Example
```go
// Define a struct analogous to the expected VICI message
type MyConfig struct {
    Key1 string `vici:"key1"`
    Key2 int    `vici:"key2"`
}

// Marshal a struct into a VICI Message
config := MyConfig{Key1: "value1", Key2: 123}
msg, err := vici.MarshalMessage(config)
if err != nil {
    // Handle error
}

// Unmarshal a VICI Message into a struct
// Assuming 'receivedMsg' is a *vici.Message received from the daemon
var receivedConfig MyConfig
err = vici.UnmarshalMessage(receivedMsg, &receivedConfig)
if err != nil {
    // Handle error
}
```

### Response
#### Success Response (200)
- **(*Message)** - For MarshalMessage, the resulting VICI Message.
- **(nil)** - For UnmarshalMessage, indicates successful unmarshalling.

#### Response Example
```go
// The result of MarshalMessage is a *vici.Message.
// UnmarshalMessage does not return a value on success, check for error.
```
```

--------------------------------

### Vici Message Structure

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

Represents a Vici message, supporting key-value pairs, lists, and sub-sections. Values can be strings, string slices, or nested Messages.

```go
type Message struct {
	// contains filtered or unexported fields
}
```

--------------------------------

### Session.NotifyEvents

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

Registers a channel to receive server-issued events. Events that the client is subscribed to will be sent to this channel.

```APIDOC
## Session.NotifyEvents

### Description
Registers a channel to receive server-issued events. Events that the client is subscribed to will be sent to this channel.

### Method
`NotifyEvents(ctx context.Context, ch chan<- *Message) error`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **ch** (chan<- *Message) - Required - The channel to which event messages will be sent.

### Request Example
```go
// Create a channel to receive events
eventChannel := make(chan *vici.Message)

// Register the channel with the session
err := session.NotifyEvents(ctx, eventChannel)
if err != nil {
    // Handle error
}

// In a separate goroutine or loop, process events from the channel
go func() {
    for event := range eventChannel {
        // Process the received event (*vici.Message)
    }
}()
```

### Response
#### Success Response (200)
- **(nil)** - Indicates successful registration of the event channel.

#### Response Example
```go
// No specific response body for success, check for error.
```
```

--------------------------------

### Check VICI Command Response for Errors

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

Use the Err method on a Message to check for command execution errors reported by the VICI server. It returns nil if the command was successful or if no 'success' field is present.

```go
func (m *Message) Err() error
```

--------------------------------

### Session.CallStreaming

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

Invokes a client-initiated command that streams events. This method is used for commands like 'list-sas' that produce a sequence of events while active. It returns an iterator that yields event messages.

```APIDOC
## Session.CallStreaming

### Description
Invokes a client-initiated command that streams events. This method is used for commands like 'list-sas' that produce a sequence of events while active. It returns an iterator that yields event messages.

### Method
`CallStreaming(ctx context.Context, cmd string, event string, msg *Message) (<-chan *Message, error)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **cmd** (string) - Required - The name of the command to invoke.
- **event** (string) - Required - The name of the event type that will be streamed.
- **msg** (*Message) - Optional - A Message containing the IN parameters for the command. Can be nil if no IN parameters are required.

### Request Example
```go
// Example of calling a streaming command and iterating over events
eventChan, err := session.CallStreaming(ctx, "list-sas", "list-sa", nil)
if err != nil {
    // Handle error
}

for event := range eventChan {
    // Process each streamed event (*vici.Message)
}
```

### Response
#### Success Response (200)
- **(<-chan *Message)** - A channel that yields [*Message, error] pairs, representing the streamed events. The channel will be closed when the command finishes or an error occurs.

#### Response Example
```go
// The channel yields *vici.Message objects for each event.
```
```

--------------------------------

### Session.Close

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

Closes the vici session, releasing any associated resources.

```APIDOC
## Session.Close

### Description
Close closes the vici session.

### Signature
```go
func (s *Session) Close() error
```
```

--------------------------------

### NotifyEvents: Register channel for received events

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

NotifyEvents registers a channel for receiving events. The session must be subscribed to events first. Writes to the channel are non-blocking; ensure sufficient buffer space to avoid discarding events. The channel is closed when the session is closed or the event listener exits.

```go
func (s *Session) NotifyEvents(c chan<- Event)
```

--------------------------------

### MarshalMessage

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

MarshalMessage encodes a Go value into a Vici Message. It supports maps and structs, with specific rules for field marshaling based on struct tags and supported types.

```APIDOC
## func MarshalMessage

### Description
MarshalMessage returns a Message encoded from v. The type of v must be either a map, struct, or struct pointer. If v is a map, the map's key type must be a string, and the type of the corresponding map element must be supported by Message.Set or MarshalMessage itself. If v is a struct or points to one, fields are only marshaled if they are exported and explicitly have a vici struct tag set. In these cases, the struct tag defines the key used for that field in the Message, and the field type must be supported by Message.Set or MarshalMessage itself. Embedded structs may be used as fields, either by explicitly giving them a field name with the vici struct tag, or by marking them as inline. Inlined structs are defined by using the opt "inline" on the vici tag, for example: `vici:",inline"`. Any field that would be encoded as an empty message element is always omitted during marshaling. However, "empty message element" is not necessarily analogous to a type's zero value in Go. Because all supported Go types are marshaled to either string, []string, or *Message, a field is considered an empty message element if it would be encoded as either an empty string, zero-length []string or nil. On the other hand, an integer's zero value is 0, but this is marshaled to the string "0", and will not be omitted from marshaling. Likewise, a bool's zero value is false, which is marshaled to the string "no".

### Example
```
{
  local_addrs = 192.168.0.1
  local {
    auth = pubkey
    certs = moonCert.pem
    id = moon.strongswan.org
  }
  remote {
    auth = pubkey
  }
  children {
    net {
      local_ts = 10.1.0.0/16
      updown = /usr/local/libexec/ipsec/_updown iptables
      esp_proposals = aes128gcm128-x25519
    }
  }
  version = 2
  proposals = aes128-sha256-x25519
}
```
```

--------------------------------

### Session.NotifyEvents

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

Registers a channel for writing received events. The Session must first subscribe to events using the Subscribe method.

```APIDOC
## Session.NotifyEvents

### Description
NotifyEvents registers c for writing received events. The Session must first subscribe to events using the Subscribe method. Writes to c will not block: the caller must ensure that c has sufficient buffer space to keep up with the expected event rate. If the write to c would block, the event is discarded. NotifyEvents may be called multiple times with different channels: each channel will independently receive a copy of each event received by the Session. When the Session is Close()'d, or the event listener otherwise exits, e.g. due to the daemon stopping or restarting, c will be closed to indicate that no more events will be passed to it.

### Signature
```go
func (s *Session) NotifyEvents(c chan<- Event)
```
```

--------------------------------

### Close: Close a Vici session

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

Close terminates the Vici session. It returns an error if the session cannot be closed properly.

```go
func (s *Session) Close() error
```

--------------------------------

### Event Type

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

The Event type represents an event received from the strongSwan VICI daemon.

```APIDOC
## type Event

### Description
Event represents an event received by a Session sent from the charon daemon. It contains an associated Message and corresponds to one of the event types registered with Session.Listen.

### Fields
#### Name string
The event type name as specified by the charon server, such as "ike-updown" or "log".

#### Message *Message
The Message associated with this event.

#### Timestamp time.Time
Timestamp holds the timestamp of when the client received the event.
```

--------------------------------

### UnsubscribeAll: Unregister all subscribed events

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

UnsubscribeAll removes the session's registration for all currently subscribed events. This is useful for resetting event listeners.

```go
func (s *Session) UnsubscribeAll() error
```

--------------------------------

### Marshal VICI Message with Struct

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

Use MarshalMessage to convert a Go struct into a VICI Message. Ensure the struct fields correspond to the expected VICI message parameters.

```go
func MarshalMessage(v interface{}) (*Message, error)
```

--------------------------------

### Marshal Go Data to VICI Message

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

Use MarshalMessage to encode Go data structures (maps, structs, struct pointers) into a VICI Message. Ensure map keys are strings and struct fields are exported with vici tags for custom naming. Empty message elements are omitted.

```go
func MarshalMessage(v any) (*Message, error)
```

```text
{
  local_addrs = 192.168.0.1
  local {
    auth = pubkey
    certs = moonCert.pem
    id = moon.strongswan.org
  }
  remote {
    auth = pubkey
  }
  children {
    net {
      local_ts = 10.1.0.0/16
      updown = /usr/local/libexec/ipsec/_updown iptables
      esp_proposals = aes128gcm128-x25519
    }
  }
  version = 2
  proposals = aes128-sha256-x25519
}

```

--------------------------------

### Message.Set

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

Set assigns a value to a specified key within a Vici Message. It supports various types including strings, integers, booleans, slices of strings, *Message, maps, and structs, returning an error if the value's type is unsupported. Existing keys are overwritten.

```APIDOC
## func (*Message) Set

### Description
Set sets key to value. An error is returned if the underlying type of v is not supported. If the type of v is supported, it is represented in the message as either a string, []string, or *Message. The currently supported types are: * string * integer types (converted to string) * bool (where true and false are converted to the strings "yes" and "no", respectively) * []string * *Message * map (the map must be valid as per MarshalMessage) * struct (the struct must be valid as per MarshalMessage) Pointer types of the above are allowed and can be used to differentiate between an unset value and a zero value. If a pointer is nil, it is not added to the message. If the key already exists the value is overwritten, but the ordering of the message is not changed.

### Example
```
{
  version = 2
  mobike = no
  local_addrs = 192.168.0.1/24
}
```
```

--------------------------------

### Message Type

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

The Message type represents a vici message, supporting key-value pairs, lists, and sub-sections.

```APIDOC
## type Message

### Description
Message represents a vici message as described in the vici README: https://github.com/strongswan/strongswan/blob/master/src/libcharon/plugins/vici/README.md

A message supports encoding key-value pairs, lists, and sub-sections (or sub-messages). Within a Message, each value, list, and sub-section is keyed by a string. The value in a key-value pair is represented by a string, lists are represented by a string slice, and sub-sections are represented by *Message. When constructing a Message, other types may be used for convenience, and may have rules on how they are converted to an appropriate internal message element type. See Message.Set and MarshalMessage for details.

### Methods
#### func MarshalMessage(v any) (*Message, error)
Marshals a Go value into a vici Message.

#### func NewMessage() *Message
Creates a new, empty vici Message.

#### func (m *Message) Err() error
Returns the error associated with the message, if any.

#### func (m *Message) Get(key string) any
Retrieves the value associated with the given key from the message.

#### func (m *Message) Keys() []string
Returns a slice of all keys present in the message.

#### func (m *Message) Set(key string, value any) error
Sets a key-value pair in the message. The value can be a string, slice of strings, or another Message.

#### func (m *Message) String() string
Returns a string representation of the message.

#### func (m *Message) Unset(key string)
Removes the key and its associated value from the message.
```

--------------------------------

### Session.UnsubscribeAll

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

Unregisters all events that the session is currently subscribed to.

```APIDOC
## Session.UnsubscribeAll

### Description
UnsubscribeAll unregisters all events that the session is currently subscribed to.

### Signature
```go
func (s *Session) UnsubscribeAll() error
```
```

--------------------------------

### Set Value in a VICI Message

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

Add or update fields in a VICI Message using the Set method. Supports strings, integers, booleans, slices of strings, *Message, maps, and structs. Pointer types can differentiate unset from zero values.

```go
func (m *Message) Set(key string, value any) error
```

```text
{
  version = 2
  mobike = no
  local_addrs = 192.168.0.1/24
}

```

--------------------------------

### StreamedCommandRequest: Send a streamed command request

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

StreamedCommandRequest sends a command with an event type for streaming. It is deprecated and CallStreaming should be used instead. It returns all received messages upon completion.

```go
func (s *Session) StreamedCommandRequest(cmd string, event string, msg *Message) ([]*Message, error)
```

--------------------------------

### Unmarshal VICI Message to Struct

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

Use UnmarshalMessage to convert a VICI Message into a Go struct. The struct fields must match the VICI message parameters for successful unmarshalling.

```go
func UnmarshalMessage(msg *Message, v interface{}) error
```

--------------------------------

### Session.Unsubscribe

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

Unsubscribes the client from one or more server-issued events. The client will no longer receive notifications for these events.

```APIDOC
## Session.Unsubscribe

### Description
Unsubscribes the client from one or more server-issued events. The client will no longer receive notifications for these events.

### Method
`Unsubscribe(ctx context.Context, events ...string) error`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **events** ([]string) - Required - A variadic list of event names to unsubscribe from.

### Request Example
```go
// Unsubscribe from 'ike-updown' event
err := session.Unsubscribe(ctx, "ike-updown")
if err != nil {
    // Handle error
}
```

### Response
#### Success Response (200)
- **(nil)** - Indicates successful unsubscription.

#### Response Example
```go
// No specific response body for success, check for error.
```
```

--------------------------------

### Unsubscribe from Server-Issued Events

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

Unsubscribe from server-issued events using the Unsubscribe method. This allows clients to stop receiving specific event notifications.

```go
func (s *Session) Unsubscribe(events ...string) error
```

--------------------------------

### Session.Unsubscribe

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

Unregisters the specified events, so the session will no longer receive events of the given type.

```APIDOC
## Session.Unsubscribe

### Description
Unsubscribe unregisters the given events, so the session will no longer receive events of the given type. If a given event is not valid, an error is returned.

### Signature
```go
func (s *Session) Unsubscribe(events ...string) error
```
```

--------------------------------

### Message.Unset

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

Unset removes a field from a Vici Message identified by its key. If the key does not exist, this operation has no effect.

```APIDOC
## func (*Message) Unset

### Description
Unset unsets the message field identified by key. There is no effect if the key does not exist.

```

--------------------------------

### UnmarshalMessage

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

UnmarshalMessage unmarshals a vici Message into a Go data structure (map or struct). It supports unmarshaling into exported struct fields with explicit vici struct tags, including inline unmarshaling.

```APIDOC
## func UnmarshalMessage

### Description
UnmarshalMessage unmarshals m to a map or struct (or struct pointer). When unmarshaling to a struct, only exported fields with a vici struct tag explicitly set are unmarshaled. Struct fields can be unmarshaled inline by providing the opt "inline" to the vici struct tag. An error is returned if the underlying value of v cannot be unmarshaled into, or an unsupported type is encountered.

### Signature
```go
func UnmarshalMessage(m *Message, v any) error
```

### Example
```
Output:
{LocalTrafficSelectors:[10.1.0.0/16] UpdownScript:/usr/local/libexec/ipsec/_updown iptables ESPProposals:[aes128gcm128-x25519]}
```
```

--------------------------------

### Message.Err

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

Err checks a command response Message for success. It returns nil if the message indicates success or lacks a 'success' field; otherwise, it returns an error derived from the 'errmsg' field.

```APIDOC
## func (*Message) Err

### Description
Err examines a command response Message, and determines if it was successful. If it was, or if the message does not contain a 'success' field, nil is returned. Otherwise, an error is returned using the 'errmsg' field.

```

--------------------------------

### Session.StopEvents

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

Stops writing received events to the specified channel.

```APIDOC
## Session.StopEvents

### Description
StopEvents stops writing received events to c.

### Signature
```go
func (s *Session) StopEvents(c chan<- Event)
```
```

--------------------------------

### Unmarshal Vici Message to Struct

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

UnmarshalMessage unmarshals a Vici Message into a Go struct or map. For structs, only exported fields with explicit vici struct tags are populated. Use the 'inline' tag option for nested struct fields.

```go
func UnmarshalMessage(m *Message, v any) error
```

--------------------------------

### StopEvents: Stop writing events to a channel

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

StopEvents ceases the delivery of received events to the specified channel. This is used to deregister a channel previously registered with NotifyEvents.

```go
func (s *Session) StopEvents(c chan<- Event)
```

--------------------------------

### Remove Field from VICI Message

Source: https://pkg.go.dev/github.com/strongswan/govici/vici

Remove a field from a VICI Message using the Unset method. This operation has no effect if the specified key does not exist in the message.

```go
func (m *Message) Unset(key string)
```
Tokens:
Raw