Documentation ¶
Index ¶
- Variables
- func BeforePreparePlug(iface Interface, plugInfo *snap.PlugInfo) error
- func BeforePrepareSlot(iface Interface, slotInfo *snap.SlotInfo) error
- func InterfaceServiceName(snapName, uniqueName string) string
- func MockSystemKey(s string) func()
- func SecurityTagGlob(snapName string) string
- func SystemKeyMismatch() (bool, error)
- func ValidateDBusBusName(busName string) error
- func WriteSystemKey() error
- type Attrer
- type ConfinementOptions
- type ConnRef
- type ConnectedPlug
- func (plug *ConnectedPlug) Apps() map[string]*snap.AppInfo
- func (plug *ConnectedPlug) Attr(key string, val interface{}) error
- func (plug *ConnectedPlug) DynamicAttrs() map[string]interface{}
- func (plug *ConnectedPlug) Hooks() map[string]*snap.HookInfo
- func (plug *ConnectedPlug) Interface() string
- func (plug *ConnectedPlug) Lookup(path string) (interface{}, bool)
- func (plug *ConnectedPlug) Name() string
- func (plug *ConnectedPlug) Ref() *PlugRef
- func (plug *ConnectedPlug) SecurityTags() []string
- func (plug *ConnectedPlug) SetAttr(key string, value interface{}) error
- func (plug *ConnectedPlug) Snap() *snap.Info
- func (plug *ConnectedPlug) StaticAttr(key string, val interface{}) error
- func (plug *ConnectedPlug) StaticAttrs() map[string]interface{}
- type ConnectedSlot
- func (slot *ConnectedSlot) Apps() map[string]*snap.AppInfo
- func (slot *ConnectedSlot) Attr(key string, val interface{}) error
- func (slot *ConnectedSlot) DynamicAttrs() map[string]interface{}
- func (slot *ConnectedSlot) Hooks() map[string]*snap.HookInfo
- func (slot *ConnectedSlot) Interface() string
- func (slot *ConnectedSlot) Lookup(path string) (interface{}, bool)
- func (slot *ConnectedSlot) Name() string
- func (slot *ConnectedSlot) Ref() *SlotRef
- func (slot *ConnectedSlot) SecurityTags() []string
- func (slot *ConnectedSlot) SetAttr(key string, value interface{}) error
- func (slot *ConnectedSlot) Snap() *snap.Info
- func (slot *ConnectedSlot) StaticAttr(key string, val interface{}) error
- func (slot *ConnectedSlot) StaticAttrs() map[string]interface{}
- type Connection
- type Info
- type InfoOptions
- type Interface
- type Interfaces
- type PlugRef
- type PlugSanitizer
- type PolicyFunc
- type Repository
- func (r *Repository) AddBackend(backend SecurityBackend) error
- func (r *Repository) AddInterface(i Interface) error
- func (r *Repository) AddPlug(plug *snap.PlugInfo) error
- func (r *Repository) AddSlot(slot *snap.SlotInfo) error
- func (r *Repository) AddSnap(snapInfo *snap.Info) error
- func (r *Repository) AllHotplugInterfaces() map[string]Interface
- func (r *Repository) AllInterfaces() []Interface
- func (r *Repository) AllPlugs(interfaceName string) []*snap.PlugInfo
- func (r *Repository) AllSlots(interfaceName string) []*snap.SlotInfo
- func (r *Repository) AutoConnectCandidatePlugs(slotSnapName, slotName string, ...) []*snap.PlugInfo
- func (r *Repository) AutoConnectCandidateSlots(plugSnapName, plugName string, ...) []*snap.SlotInfo
- func (r *Repository) Backends() []SecurityBackend
- func (r *Repository) Connect(ref *ConnRef, ...) (*Connection, error)
- func (r *Repository) Connected(snapName, plugOrSlotName string) ([]*ConnRef, error)
- func (r *Repository) Connection(connRef *ConnRef) (*Connection, error)
- func (r *Repository) Connections(snapName string) ([]*ConnRef, error)
- func (r *Repository) ConnectionsForHotplugKey(ifaceName string, hotplugKey snap.HotplugKey) ([]*ConnRef, error)
- func (r *Repository) Disconnect(plugSnapName, plugName, slotSnapName, slotName string) error
- func (r *Repository) DisconnectAll(conns []*ConnRef)
- func (r *Repository) DisconnectSnap(snapName string) ([]string, error)
- func (r *Repository) Info(opts *InfoOptions) []*Info
- func (r *Repository) Interface(interfaceName string) Interface
- func (r *Repository) Interfaces() *Interfaces
- func (r *Repository) Plug(snapName, plugName string) *snap.PlugInfo
- func (r *Repository) Plugs(snapName string) []*snap.PlugInfo
- func (r *Repository) RemovePlug(snapName, plugName string) error
- func (r *Repository) RemoveSlot(snapName, slotName string) error
- func (r *Repository) RemoveSnap(snapName string) error
- func (r *Repository) ResolveConnect(plugSnapName, plugName, slotSnapName, slotName string) (*ConnRef, error)
- func (r *Repository) ResolveDisconnect(plugSnapName, plugName, slotSnapName, slotName string) ([]*ConnRef, error)
- func (r *Repository) Slot(snapName, slotName string) *snap.SlotInfo
- func (r *Repository) SlotForHotplugKey(ifaceName string, hotplugKey snap.HotplugKey) (*snap.SlotInfo, error)
- func (r *Repository) Slots(snapName string) []*snap.SlotInfo
- func (r *Repository) SnapSpecification(securitySystem SecuritySystem, snapName string) (Specification, error)
- func (r *Repository) UpdateHotplugSlotAttrs(ifaceName string, hotplugKey snap.HotplugKey, ...) (*snap.SlotInfo, error)
- type SecurityBackend
- type SecuritySystem
- type SlotRef
- type SlotSanitizer
- type Specification
- type StaticInfo
- type UnknownPlugSlotError
Constants ¶
This section is empty.
Variables ¶
var ( ErrSystemKeyVersion = errors.New("system-key versions not comparable") ErrSystemKeyMissing = errors.New("system-key missing on disk") )
ErrSystemKeyIncomparableVersions indicates that the system-key on disk and the system-key calculated from generateSystemKey have different inputs and are therefore incomparable.
This means: - "snapd" needs to re-generate security profiles - "snap run" cannot wait for those security profiles
Functions ¶
func BeforePreparePlug ¶
Sanitize plug with a given snapd interface.
func BeforePrepareSlot ¶
Sanitize slot with a given snapd interface.
func InterfaceServiceName ¶
func MockSystemKey ¶
func MockSystemKey(s string) func()
func SecurityTagGlob ¶
SecurityTagGlob returns a pattern that matches all security tags belonging to the same snap as the given app.
func SystemKeyMismatch ¶
SystemKeyMismatch checks if the running binary expects a different system-key than what is on disk.
This is used in two places:
- snap run: when there is a mismatch it will wait for snapd to re-generate the security profiles
- snapd: on startup it checks if the system-key has changed and if so re-generate the security profiles
This ensures that "snap run" and "snapd" have a consistent set of security profiles. Without it we may have the following scenario:
- snapd gets refreshed and snaps need updated security profiles to work (e.g. because snap-exec needs a new permission)
- The system reboots to start the new snapd. At this point the old security profiles are on disk (because the new snapd did not run yet)
- Snaps that run as daemon get started during boot by systemd (e.g. network-manager). This may happen before snapd had a chance to refresh the security profiles.
- Because the security profiles are for the old version of the snaps that run before snapd fail to start. For e.g. network-manager this is of course catastrophic.
To prevent this, in step(4) we have this wait-for-snapd step to ensure the expected profiles are on disk.
The apparmor-parser-features system-key is handled specially and not included in this comparison because it is written out to disk whenever apparmor-parser-mtime changes (in this manner snap run only has to obtain the mtime of apparmor_parser and doesn't have to invoke it)
func ValidateDBusBusName ¶
ValidateDBusBusName checks if a string conforms to https://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-names
func WriteSystemKey ¶
func WriteSystemKey() error
WriteSystemKey will write the current system-key to disk
Types ¶
type Attrer ¶
type Attrer interface { // Attr returns attribute value for given path, or an error. Dotted paths are supported. Attr(path string, value interface{}) error // Lookup returns attribute value for given path, or false. Dotted paths are supported. Lookup(path string) (value interface{}, ok bool) }
Attrer is an interface with Attr getter method common to ConnectedSlot, ConnectedPlug, PlugInfo and SlotInfo types.
type ConfinementOptions ¶
type ConfinementOptions struct { // DevMode flag switches confinement to non-enforcing mode. DevMode bool // JailMode flag switches confinement to enforcing mode. JailMode bool // Classic flag switches the core snap "chroot" off. Classic bool }
ConfinementOptions describe confinement configuration.
The confinement system controls the initial layout of the mount namespace as well as the set of actions a process is allowed to perform. Confinement is initially defined by the ConfinementType declared by the snap. It can be either "strict", "devmode" or "classic".
The "strict" type uses mount layout that puts the core snap as the root filesystem and provides strong isolation from the system and from other snaps. Violations cause permission errors or mandatory process termination.
The "devmode" type uses the same mount layout as "strict" but switches confinement to non-enforcing mode whenever possible. Violations that would result in permission error or process termination are instead permitted. A diagnostic message is logged when this occurs.
The "classic" type uses mount layout that is identical to the runtime of the classic system snapd runs in, in other words there is no "chroot". Most of the confinement is lifted, specifically there's no seccomp filter being applied and apparmor is using complain mode by default.
The three types defined above map to some combinations of the three flags defined below.
The DevMode flag attempts to switch all confinement facilities into non-enforcing mode even if the snap requested otherwise.
The JailMode flag attempts to switch all confinement facilities into enforcing mode even if the snap requested otherwise.
The Classic flag switches the layout of the mount namespace so that there's no "chroot" to the core snap.
type ConnRef ¶
ConnRef holds information about plug and slot reference that form a particular connection.
func NewConnRef ¶
NewConnRef creates a connection reference for given plug and slot
func (*ConnRef) SortsBefore ¶
SortsBefore returns true when connection should be sorted before the other
type ConnectedPlug ¶
type ConnectedPlug struct {
// contains filtered or unexported fields
}
ConnectedPlug represents a plug that is connected to a slot.
func NewConnectedPlug ¶
func NewConnectedPlug(plug *snap.PlugInfo, staticAttrs, dynamicAttrs map[string]interface{}) *ConnectedPlug
NewConnectedPlug creates an object representing a connected plug.
func (*ConnectedPlug) Apps ¶
func (plug *ConnectedPlug) Apps() map[string]*snap.AppInfo
Apps returns all the apps associated with this plug.
func (*ConnectedPlug) Attr ¶
func (plug *ConnectedPlug) Attr(key string, val interface{}) error
Attr returns a dynamic attribute with the given name. It falls back to returning static attribute if dynamic one doesn't exist. Error is returned if neither dynamic nor static attribute exist.
func (*ConnectedPlug) DynamicAttrs ¶
func (plug *ConnectedPlug) DynamicAttrs() map[string]interface{}
DynamicAttrs returns all dynamic attributes.
func (*ConnectedPlug) Hooks ¶
func (plug *ConnectedPlug) Hooks() map[string]*snap.HookInfo
Hooks returns all the hooks associated with this plug.
func (*ConnectedPlug) Interface ¶
func (plug *ConnectedPlug) Interface() string
Interface returns the name of the interface for this plug.
func (*ConnectedPlug) Lookup ¶
func (plug *ConnectedPlug) Lookup(path string) (interface{}, bool)
func (*ConnectedPlug) Name ¶
func (plug *ConnectedPlug) Name() string
Name returns the name of this plug.
func (*ConnectedPlug) Ref ¶
func (plug *ConnectedPlug) Ref() *PlugRef
Ref returns the PlugRef for this plug.
func (*ConnectedPlug) SecurityTags ¶
func (plug *ConnectedPlug) SecurityTags() []string
SecurityTags returns the security tags for this plug.
func (*ConnectedPlug) SetAttr ¶
func (plug *ConnectedPlug) SetAttr(key string, value interface{}) error
SetAttr sets the given dynamic attribute. Error is returned if the key is already used by a static attribute.
func (*ConnectedPlug) Snap ¶
func (plug *ConnectedPlug) Snap() *snap.Info
Snap returns the snap Info of this plug.
func (*ConnectedPlug) StaticAttr ¶
func (plug *ConnectedPlug) StaticAttr(key string, val interface{}) error
StaticAttr returns a static attribute with the given key, or error if attribute doesn't exist.
func (*ConnectedPlug) StaticAttrs ¶
func (plug *ConnectedPlug) StaticAttrs() map[string]interface{}
StaticAttrs returns all static attributes.
type ConnectedSlot ¶
type ConnectedSlot struct {
// contains filtered or unexported fields
}
ConnectedSlot represents a slot that is connected to a plug.
func NewConnectedSlot ¶
func NewConnectedSlot(slot *snap.SlotInfo, staticAttrs, dynamicAttrs map[string]interface{}) *ConnectedSlot
NewConnectedSlot creates an object representing a connected slot.
func (*ConnectedSlot) Apps ¶
func (slot *ConnectedSlot) Apps() map[string]*snap.AppInfo
Apps returns all the apps associated with this slot.
func (*ConnectedSlot) Attr ¶
func (slot *ConnectedSlot) Attr(key string, val interface{}) error
Attr returns a dynamic attribute with the given name. It falls back to returning static attribute if dynamic one doesn't exist. Error is returned if neither dynamic nor static attribute exist.
func (*ConnectedSlot) DynamicAttrs ¶
func (slot *ConnectedSlot) DynamicAttrs() map[string]interface{}
DynamicAttrs returns all dynamic attributes.
func (*ConnectedSlot) Hooks ¶
func (slot *ConnectedSlot) Hooks() map[string]*snap.HookInfo
Hooks returns all the hooks associated with this slot.
func (*ConnectedSlot) Interface ¶
func (slot *ConnectedSlot) Interface() string
Interface returns the name of the interface for this slot.
func (*ConnectedSlot) Lookup ¶
func (slot *ConnectedSlot) Lookup(path string) (interface{}, bool)
func (*ConnectedSlot) Name ¶
func (slot *ConnectedSlot) Name() string
Name returns the name of this slot.
func (*ConnectedSlot) Ref ¶
func (slot *ConnectedSlot) Ref() *SlotRef
Ref returns the SlotRef for this slot.
func (*ConnectedSlot) SecurityTags ¶
func (slot *ConnectedSlot) SecurityTags() []string
SecurityTags returns the security tags for this slot.
func (*ConnectedSlot) SetAttr ¶
func (slot *ConnectedSlot) SetAttr(key string, value interface{}) error
SetAttr sets the given dynamic attribute. Error is returned if the key is already used by a static attribute.
func (*ConnectedSlot) Snap ¶
func (slot *ConnectedSlot) Snap() *snap.Info
Snap returns the snap Info of this slot.
func (*ConnectedSlot) StaticAttr ¶
func (slot *ConnectedSlot) StaticAttr(key string, val interface{}) error
StaticAttr returns a static attribute with the given key, or error if attribute doesn't exist.
func (*ConnectedSlot) StaticAttrs ¶
func (slot *ConnectedSlot) StaticAttrs() map[string]interface{}
StaticAttrs returns all static attributes.
type Connection ¶
type Connection struct { Plug *ConnectedPlug Slot *ConnectedSlot }
Connection represents a connection between a particular plug and slot.
func (*Connection) Interface ¶
func (conn *Connection) Interface() string
Interface returns the name of the interface for this connection.
type Info ¶
type Info struct { Name string Summary string DocURL string Plugs []*snap.PlugInfo Slots []*snap.SlotInfo }
Info holds information about a given interface and its instances.
type InfoOptions ¶
InfoOptions describes options for Info.
Names: return just this subset if non-empty. Doc: return documentation. Plugs: return information about plugs. Slots: return information about slots. Connected: only consider interfaces with at least one connection.
type Interface ¶
type Interface interface { // Unique and public name of this interface. Name() string // AutoConnect returns whether plug and slot should be // implicitly auto-connected assuming they will be an // unambiguous connection candidate and declaration-based checks // allow. AutoConnect(plug *snap.PlugInfo, slot *snap.SlotInfo) bool }
Interface describes a group of interchangeable capabilities with common features. Interfaces act as a contract between system builders, application developers and end users.
type Interfaces ¶
Interfaces holds information about a list of plugs, slots and their connections.
type PlugRef ¶
PlugRef is a reference to a plug.
func (PlugRef) SortsBefore ¶
SortsBefore returns true when plug should be sorted before the other
type PlugSanitizer ¶
PlugSanitizer can be implemented by Interfaces that have reasons to sanitize their plugs.
type PolicyFunc ¶
type PolicyFunc func(*ConnectedPlug, *ConnectedSlot) (bool, error)
type Repository ¶
type Repository struct {
// contains filtered or unexported fields
}
Repository stores all known snappy plugs and slots and ifaces.
func NewRepository ¶
func NewRepository() *Repository
NewRepository creates an empty plug repository.
func (*Repository) AddBackend ¶
func (r *Repository) AddBackend(backend SecurityBackend) error
AddBackend adds the provided security backend to the repository.
func (*Repository) AddInterface ¶
func (r *Repository) AddInterface(i Interface) error
AddInterface adds the provided interface to the repository.
func (*Repository) AddPlug ¶
func (r *Repository) AddPlug(plug *snap.PlugInfo) error
AddPlug adds a plug to the repository. Plug names must be valid snap names, as defined by ValidateName. Plug name must be unique within a particular snap.
func (*Repository) AddSlot ¶
func (r *Repository) AddSlot(slot *snap.SlotInfo) error
AddSlot adds a new slot to the repository. Adding a slot with invalid name returns an error. Adding a slot that has the same name and snap name as another slot returns an error.
func (*Repository) AddSnap ¶
func (r *Repository) AddSnap(snapInfo *snap.Info) error
AddSnap adds plugs and slots declared by the given snap to the repository.
This function can be used to implement snap install or, when used along with RemoveSnap, snap upgrade.
AddSnap doesn't change existing plugs/slots. The caller is responsible for ensuring that the snap is not present in the repository in any way prior to calling this function. If this constraint is violated then no changes are made and an error is returned.
Each added plug/slot is validated according to the corresponding interface. Unknown interfaces and plugs/slots that don't validate are not added. Information about those failures are returned to the caller.
func (*Repository) AllHotplugInterfaces ¶
func (r *Repository) AllHotplugInterfaces() map[string]Interface
AllHotplugInterfaces returns all interfaces that handle hotplug events.
func (*Repository) AllInterfaces ¶
func (r *Repository) AllInterfaces() []Interface
AllInterfaces returns all the interfaces added to the repository, ordered by name.
func (*Repository) AllPlugs ¶
func (r *Repository) AllPlugs(interfaceName string) []*snap.PlugInfo
AllPlugs returns all plugs of the given interface. If interfaceName is the empty string, all plugs are returned.
func (*Repository) AllSlots ¶
func (r *Repository) AllSlots(interfaceName string) []*snap.SlotInfo
AllSlots returns all slots of the given interface. If interfaceName is the empty string, all slots are returned.
func (*Repository) AutoConnectCandidatePlugs ¶
func (r *Repository) AutoConnectCandidatePlugs(slotSnapName, slotName string, policyCheck func(*ConnectedPlug, *ConnectedSlot) (bool, error)) []*snap.PlugInfo
AutoConnectCandidatePlugs finds and returns viable auto-connection candidates for a given slot.
func (*Repository) AutoConnectCandidateSlots ¶
func (r *Repository) AutoConnectCandidateSlots(plugSnapName, plugName string, policyCheck func(*ConnectedPlug, *ConnectedSlot) (bool, error)) []*snap.SlotInfo
AutoConnectCandidateSlots finds and returns viable auto-connection candidates for a given plug.
func (*Repository) Backends ¶
func (r *Repository) Backends() []SecurityBackend
Backends returns all the security backends. The order is the same as the order in which they were inserted.
func (*Repository) Connect ¶
func (r *Repository) Connect(ref *ConnRef, plugStaticAttrs, plugDynamicAttrs, slotStaticAttrs, slotDynamicAttrs map[string]interface{}, policyCheck PolicyFunc) (*Connection, error)
Connect establishes a connection between a plug and a slot. The plug and the slot must have the same interface. When connections are reloaded policyCheck is null (we don't check policy again).
func (*Repository) Connected ¶
func (r *Repository) Connected(snapName, plugOrSlotName string) ([]*ConnRef, error)
Connected returns references for all connections that are currently established with the provided plug or slot.
func (*Repository) Connection ¶
func (r *Repository) Connection(connRef *ConnRef) (*Connection, error)
Connection returns the specified Connection object or an error.
func (*Repository) Connections ¶
func (r *Repository) Connections(snapName string) ([]*ConnRef, error)
func (*Repository) ConnectionsForHotplugKey ¶
func (r *Repository) ConnectionsForHotplugKey(ifaceName string, hotplugKey snap.HotplugKey) ([]*ConnRef, error)
ConnectionsForHotplugKey returns all hotplug connections for given interface name and hotplug key.
func (*Repository) Disconnect ¶
func (r *Repository) Disconnect(plugSnapName, plugName, slotSnapName, slotName string) error
Disconnect disconnects the named plug from the slot of the given snap.
Disconnect() finds a specific slot and a specific plug and disconnects that plug from that slot. It is an error if plug or slot cannot be found or if the connect does not exist.
func (*Repository) DisconnectAll ¶
func (r *Repository) DisconnectAll(conns []*ConnRef)
DisconnectAll disconnects all provided connection references.
func (*Repository) DisconnectSnap ¶
func (r *Repository) DisconnectSnap(snapName string) ([]string, error)
DisconnectSnap disconnects all the connections to and from a given snap.
The return value is a list of names that were affected.
func (*Repository) Info ¶
func (r *Repository) Info(opts *InfoOptions) []*Info
Info returns information about interfaces in the system.
If names is empty then all interfaces are considered. Query options decide which data to return but can also skip interfaces without connections. See the documentation of InfoOptions for details.
func (*Repository) Interface ¶
func (r *Repository) Interface(interfaceName string) Interface
Interface returns an interface with a given name.
func (*Repository) Interfaces ¶
func (r *Repository) Interfaces() *Interfaces
Interfaces returns object holding a lists of all the plugs and slots and their connections.
func (*Repository) Plug ¶
func (r *Repository) Plug(snapName, plugName string) *snap.PlugInfo
Plug returns the specified plug from the named snap.
func (*Repository) Plugs ¶
func (r *Repository) Plugs(snapName string) []*snap.PlugInfo
Plugs returns the plugs offered by the named snap.
func (*Repository) RemovePlug ¶
func (r *Repository) RemovePlug(snapName, plugName string) error
RemovePlug removes the named plug provided by a given snap. The removed plug must exist and must not be used anywhere.
func (*Repository) RemoveSlot ¶
func (r *Repository) RemoveSlot(snapName, slotName string) error
RemoveSlot removes a named slot from the given snap. Removing a slot that doesn't exist returns an error. Removing a slot that is connected to a plug returns an error.
func (*Repository) RemoveSnap ¶
func (r *Repository) RemoveSnap(snapName string) error
RemoveSnap removes all the plugs and slots associated with a given snap.
This function can be used to implement snap removal or, when used along with AddSnap, snap upgrade.
RemoveSnap does not remove connections. The caller is responsible for ensuring that connections are broken before calling this method. If this constraint is violated then no changes are made and an error is returned.
func (*Repository) ResolveConnect ¶
func (r *Repository) ResolveConnect(plugSnapName, plugName, slotSnapName, slotName string) (*ConnRef, error)
ResolveConnect resolves potentially missing plug or slot names and returns a fully populated connection reference.
func (*Repository) ResolveDisconnect ¶
func (r *Repository) ResolveDisconnect(plugSnapName, plugName, slotSnapName, slotName string) ([]*ConnRef, error)
ResolveDisconnect resolves potentially missing plug or slot names and returns a list of fully populated connection references that can be disconnected.
It can be used in two different ways: 1: snap disconnect <snap>:<plug> <snap>:<slot> 2: snap disconnect <snap>:<plug or slot>
In the first case the referenced plug and slot must be connected. In the second case any matching connection are returned but it is not an error if there are no connections.
In both cases the snap name can be omitted to implicitly refer to the core snap. If there's no core snap it is simply assumed to be called "core" to provide consistent error messages.
func (*Repository) Slot ¶
func (r *Repository) Slot(snapName, slotName string) *snap.SlotInfo
Slot returns the specified slot from the named snap.
func (*Repository) SlotForHotplugKey ¶
func (r *Repository) SlotForHotplugKey(ifaceName string, hotplugKey snap.HotplugKey) (*snap.SlotInfo, error)
SlotForHotplugKey returns a hotplug slot for given interface name and hotplug key or nil if there is no slot.
func (*Repository) Slots ¶
func (r *Repository) Slots(snapName string) []*snap.SlotInfo
Slots returns the slots offered by the named snap.
func (*Repository) SnapSpecification ¶
func (r *Repository) SnapSpecification(securitySystem SecuritySystem, snapName string) (Specification, error)
SnapSpecification returns the specification of a given snap in a given security system.
func (*Repository) UpdateHotplugSlotAttrs ¶
func (r *Repository) UpdateHotplugSlotAttrs(ifaceName string, hotplugKey snap.HotplugKey, staticAttrs map[string]interface{}) (*snap.SlotInfo, error)
UpdateHotplugSlotAttrs updates static attributes of hotplug slot associated with given hotplugkey, and returns the resulting slot. Slots can only be updated if not connected to any plug.
type SecurityBackend ¶
type SecurityBackend interface { // Initialize performs any initialization required by the backend. // It is called during snapd startup process. Initialize() error // Name returns the name of the backend. // This is intended for diagnostic messages. Name() SecuritySystem // Setup creates and loads security artefacts specific to a given snap. // The snap can be in one of three kids onf confinement (strict mode, // developer mode or classic mode). In the last two security violations // are non-fatal to the offending application process. // // This method should be called after changing plug, slots, connections // between them or application present in the snap. Setup(snapInfo *snap.Info, opts ConfinementOptions, repo *Repository, tm timings.Measurer) error // Remove removes and unloads security artefacts of a given snap. // // This method should be called during the process of removing a snap. Remove(snapName string) error // NewSpecification returns a new specification associated with this backend. NewSpecification() Specification // SandboxFeatures returns a list of tags that identify sandbox features. SandboxFeatures() []string }
SecurityBackend abstracts interactions between the interface system and the needs of a particular security system.
type SecuritySystem ¶
type SecuritySystem string
SecuritySystem is a name of a security system.
const ( // SecurityAppArmor identifies the apparmor security system. SecurityAppArmor SecuritySystem = "apparmor" // SecuritySecComp identifies the seccomp security system. SecuritySecComp SecuritySystem = "seccomp" // SecurityDBus identifies the DBus security system. SecurityDBus SecuritySystem = "dbus" // SecurityUDev identifies the UDev security system. SecurityUDev SecuritySystem = "udev" // SecurityMount identifies the mount security system. SecurityMount SecuritySystem = "mount" // SecurityKMod identifies the kernel modules security system SecurityKMod SecuritySystem = "kmod" // SecuritySystemd identifies the systemd services security system SecuritySystemd SecuritySystem = "systemd" )
type SlotRef ¶
SlotRef is a reference to a slot.
func (SlotRef) SortsBefore ¶
SortsBefore returns true when slot should be sorted before the other
type SlotSanitizer ¶
SlotSanitizer can be implemented by Interfaces that have reasons to sanitize their slots.
type Specification ¶
type Specification interface { // AddPermanentSlot records side-effects of having a slot. AddPermanentSlot(iface Interface, slot *snap.SlotInfo) error // AddPermanentPlug records side-effects of having a plug. AddPermanentPlug(iface Interface, plug *snap.PlugInfo) error // AddConnectedSlot records side-effects of having a connected slot. AddConnectedSlot(iface Interface, plug *ConnectedPlug, slot *ConnectedSlot) error // AddConnectedPlug records side-effects of having a connected plug. AddConnectedPlug(iface Interface, plug *ConnectedPlug, slot *ConnectedSlot) error }
Specification describes interactions between backends and interfaces.
type StaticInfo ¶
type StaticInfo struct { Summary string `json:"summary,omitempty"` DocURL string `json:"doc-url,omitempty"` // ImplicitOnCore controls if a slot is automatically added to core (non-classic) systems. ImplicitOnCore bool `json:"implicit-on-core,omitempty"` // ImplicitOnClassic controls if a slot is automatically added to classic systems. ImplicitOnClassic bool `json:"implicit-on-classic,omitempty"` // BaseDeclarationPlugs defines an optional extension to the base-declaration assertion relevant for this interface. BaseDeclarationPlugs string // BaseDeclarationSlots defines an optional extension to the base-declaration assertion relevant for this interface. BaseDeclarationSlots string }
StaticInfo describes various static-info of a given interface.
The Summary must be a one-line string of length suitable for listing views. The DocsURL can point to website (e.g. a forum thread) that goes into more depth and documents the interface in detail.
func StaticInfoOf ¶
func StaticInfoOf(iface Interface) (si StaticInfo)
StaticInfoOf returns the static-info of the given interface.
type UnknownPlugSlotError ¶
type UnknownPlugSlotError struct {
Msg string
}
UnknownPlugSlotError is an error reported when plug or slot cannot be found.
func (*UnknownPlugSlotError) Error ¶
func (e *UnknownPlugSlotError) Error() string
Error returns the message associated with unknown plug or slot error.
Source Files ¶
Directories ¶
Path | Synopsis |
---|---|
Package apparmor contains primitives for working with apparmor.
|
Package apparmor contains primitives for working with apparmor. |
Package dbus implements interaction between snappy and dbus.
|
Package dbus implements interaction between snappy and dbus. |
Package kmod implements a backend which loads kernel modules on behalf of interfaces.
|
Package kmod implements a backend which loads kernel modules on behalf of interfaces. |
Package mount implements mounts that get mapped into the snap Snappy creates fstab like configuration files that describe what directories from the system or from other snaps should get mapped into the snap.
|
Package mount implements mounts that get mapped into the snap Snappy creates fstab like configuration files that describe what directories from the system or from other snaps should get mapped into the snap. |
Package policy implements the declaration based policy checks for connecting or permitting installation of snaps based on their slots and plugs.
|
Package policy implements the declaration based policy checks for connecting or permitting installation of snaps based on their slots and plugs. |
Package seccomp implements integration between snapd and snap-confine around seccomp.
|
Package seccomp implements integration between snapd and snap-confine around seccomp. |
Package systemd implements integration between snappy interfaces and arbitrary systemd units that may be required for "oneshot" style tasks.
|
Package systemd implements integration between snappy interfaces and arbitrary systemd units that may be required for "oneshot" style tasks. |
Package udev implements integration between snapd, udev and snap-confine around tagging character and block devices so that they can be accessed by applications.
|
Package udev implements integration between snapd, udev and snap-confine around tagging character and block devices so that they can be accessed by applications. |