tree: 187d36bd6334df82610dfa06f87aa08618b6c44e [path history] [tgz]
  1. _toc.yaml
  2. directory.md
  3. event.md
  4. life_of_a_protocol_open.md
  5. protocol.md
  6. README.md
  7. resolvers.md
  8. runners.md
  9. service.md
  10. storage.md
docs/concepts/components/v2/capabilities/README.md

Capabilities

Components interact with one another through capabilities. A capability combines access to a resource and a set of rights, providing a access control and a means for interacting with the resource. Fuchsia capabilities typically access underlying kernel objects through handles provided in the component's namespace.

A component can interact with the system and other components only through the discoverable capabilities from its namespace and the few numbered handles it receives.

Capability routing

Components declare new capabilities that they offer to the system and capabilities provided by other components (or the framework) that they require in their component manifest. Component framework uses these declarations to populate the namespace.

For capabilities to be available at runtime, there must also be a valid capability route from the consuming component to a provider. Since capabilities are most often routed through parent components to their children, parent components play an important role in defining the sandboxes for their child components.

Some capability types are routed to environments rather than individual component instances. Environments configure the behavior of the framework for the realms where they are assigned. Capabilities routed to environments are accessed and used by the framework. Component instances do not have runtime access to the capabilities in their environment.

Routing terminology

Routing terminology divides into the following categories:

  1. Declarations of how capabilities are routed between the component, its parent, and its children:
    • offer: Declares that the capability listed is made available to a child component instance or a child collection.
    • expose: Declares that the capabilities listed are made available to the parent component or to the framework. It is valid to expose from self or from a child component.
  2. Declarations of capabilities consumed or provided by the component:
    • use: For executable components, declares capabilities that this component requires in its namespace at runtime. Capabilities are routed from the parent unless otherwise specified, and each capability must have a valid route from its source.
    • capabilities: Declares capabilities that this component provides. Capabilities that are offered or exposed from self must appear here. These capabilities often map to a node in the outgoing directory.

Capability types

The following capabilities can be routed:

typedescriptionrouted to
[protocol]A filesystem node that iscomponents
: capability-protocol : used to open a channel backed : :
: : by a FIDL protocol. : :
[service]A filesystem directory thatcomponents
: capability-service : is used to open a channel to : :
: : one of several service : :
: : instances. : :
[directory]A filesystem directory.components
: capability-directory : : :
[storage]A writable filesystemcomponents
: capability-storage : directory that is isolated to : :
: : the component using it. : :
[resolver]A capability that, when[environments]
: capability-resolver : registered in an environment, : doc-environments :
: : causes a component with a : :
: : particular URL scheme to be : :
: : resolved with that resolver. : :
[runner]A capability that, when[environments]
: capability-runner : registered in an environment, : doc-environments :
: : allows the framework to use : :
: : that runner when starting : :
: : components. : :

Examples

Consider the following example that describes capability routing through the component instance tree:


Capability routing example

In this example:

  • The echo component instance provides the fuchsia.Echo protocol as one of its declared capabilities.
  • The echo_tool component instance requires the use of the fuchsia.Echo protocol capability.

Each intermediate component cooperates to explicitly route fuchsia.Echo from echo to echo_tool:

  1. echo exposes fuchsia.Echo from self so the protocol is visible to its parent, services.
  2. services exposes fuchsia.Echo from its child echo to its parent, shell.
  3. shell offers fuchsia.Echo from its child services to another child, tools.
  4. tools offers fuchsia.Echo from parent to its child, echo_tool.

Component Framework grants the request from echo_tool to use fuchsia.Echo because a valid route is found to a component providing that protocol capability.

For more information on how components connect to capabilities at runtime, see Life of a protocol open.