NervesSSH

https://nerves-ssh.hexdocs.pm/
Admin
NervesSSH is a library that wraps Erlang/OTP's SSH daemon to manage an SSH daemon and its subsystems...
Tokens:8,815
Snippets:115
Trust Score:9
Update:4 months ago
Show doc for...
Tokens:
Raw
### Configure Shoehorn for Automatic Startup

Source: https://nerves-ssh.hexdocs.pm/

Include :nerves_ssh in the :init list for :shoehorn to ensure it starts automatically. This is an alternative to manual supervision tree integration.

```elixir
config :shoehorn,
  init: [:nerves_runtime, :vintage_net, :nerves_ssh]
```

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

### Get SSH Daemon Options

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.Options.md

Retrieves the options formatted for the Erlang :ssh.daemon/2 function.

```elixir
@spec daemon_options(t()) :: :ssh.daemon_options()
```

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

### child_spec

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.md

Returns a supervisor child specification for starting the NervesSSH module within a supervision tree.

```APIDOC
## child_spec

### Description
Returns a supervisor child specification for starting the NervesSSH module within a supervision tree.

### Method
`NervesSSH.child_spec/0`

### Returns
A supervisor child specification.
```

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

### new

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.Options.md

Creates a new NervesSSH.Options struct from a keyword list.

```APIDOC
## new

### Description

Convert keyword options to the NervesSSH.Options

### Method

`NervesSSH.Options.new/1`

### Parameters

#### Path Parameters

- **keyword_options** (keyword()) - Required - A keyword list of options to convert.
```

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

### configuration

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.md

Reads and returns the current configuration options for the NervesSSH instance. This includes settings like authorized keys and user passwords.

```APIDOC
## configuration

### Description
Reads and returns the current configuration options for the NervesSSH instance. This includes settings like authorized keys and user passwords.

### Method
`NervesSSH.configuration/1`

### Parameters
#### Path Parameters
- **name** (GenServer.name()) - The name of the NervesSSH instance.

### Returns
- `NervesSSH.Options.t()` - The current configuration options.
```

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

### Create NervesSSH Options with Defaults

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.Options.md

Creates a new NervesSSH.Options struct, filling in default values for any missing options.

```elixir
@spec with_defaults(keyword()) :: t()
```

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

### Configure Public Keys by Reading from File

Source: https://nerves-ssh.hexdocs.pm/

This method reads public SSH keys from a specified file path, such as '~/.ssh/id_rsa.pub'. It avoids committing keys directly into the configuration.

```elixir
config :nerves_ssh,
  authorized_keys: [
    File.read!(Path.join(System.user_home!, ".ssh/id_rsa.pub"))
  ]
```

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

### Add User Credentials at Runtime

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.md

Add a user and their password (or set to passwordless) to the SSH daemon at runtime. These credentials are not persisted across restarts.

```elixir
NervesSSH.add_user("username", "password")
```

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

### Create New NervesSSH Options

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.Options.md

Converts a keyword list of options into a NervesSSH.Options struct.

```elixir
@spec new(keyword()) :: t()
```

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

### Configure Username/Password Authentication

Source: https://nerves-ssh.hexdocs.pm/

Set up username and password authentication for Nerves SSH. Note that passwords are stored in plain text and this is not recommended for most production scenarios.

```elixir
config :nerves_ssh,
  user_passwords: [
    {"username", "password"}
  ]
```

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

### Generate Upload Script for Nerves Firmware

Source: https://nerves-ssh.hexdocs.pm/readme.md

Generate an upload.sh script using the mix firmware.gen.script command, necessary for firmware updates when migrating from NervesFirmwareSSH.

```shell
mix firmware.gen.script
```

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

### Configure SSH Client for Host Key Changes

Source: https://nerves-ssh.hexdocs.pm/

Add this configuration to your ~/.ssh/config to prevent SSH client errors when NervesSSH regenerates host keys, common during frequent MicroSD card rewrites.

```bash
Host nerves.local
    UserKnownHostsFile /dev/null
    StrictHostKeyChecking no
```

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

### Automate Configuration File Updates

Source: https://nerves-ssh.hexdocs.pm/

This shell command searches recursively for files containing 'nerves_firmware_ssh' and replaces it with 'nerves_ssh'. Use with caution and review changes before committing.

```shell
grep -RIl nerves_firmware_ssh config/ | xargs sed -i 's/nerves_firmware_ssh/nerves_ssh/g'
```

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

### Load Authorized Keys

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.Options.md

Loads authorized keys from the specified file into the NervesSSH options struct.

```elixir
@spec load_authorized_keys(t()) :: t()
```

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

### with_defaults

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.Options.md

Creates a new NervesSSH.Options struct with default values applied.

```APIDOC
## with_defaults

### Description

Create a new NervesSSH.Options and fill in defaults

### Method

`NervesSSH.Options.with_defaults/1`

### Parameters

#### Path Parameters

- **keyword_options** (keyword()) - Required - A keyword list of options to start with.
```

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

### daemon_options

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.Options.md

Converts NervesSSH options into the format required by `:ssh.daemon/2`.

```APIDOC
## daemon_options

### Description

Return :ssh.daemon_options()

### Method

`NervesSSH.Options.daemon_options/1`

### Parameters

#### Path Parameters

- **options** (t()) - Required - The NervesSSH options struct.
```

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

### load_authorized_keys

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.Options.md

Loads authorized keys from the `authorized_keys` file into the NervesSSH options struct.

```APIDOC
## load_authorized_keys

### Description

Load authorized keys from the authorized_keys file

### Method

`NervesSSH.Options.load_authorized_keys/1`

### Parameters

#### Path Parameters

- **options** (t()) - Required - The NervesSSH options struct.
```

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

### add_user

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.md

Adds a user credential (username and password) to the SSH daemon. Setting the password to an empty string or nil results in passwordless authentication for that user. These credentials are not persisted across restarts.

```APIDOC
## add_user

### Description
Adds a user credential (username and password) to the SSH daemon. Setting the password to an empty string or nil results in passwordless authentication for that user. These credentials are not persisted across restarts.

### Method
`NervesSSH.add_user/3`

### Parameters
#### Path Parameters
- **name** (GenServer.name()) - The name of the NervesSSH instance.
- **username** (String.t()) - The username for the credential.
- **password** (String.t() | nil) - The password for the credential. Can be `nil` or `""` for passwordless authentication.
```

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

### add_user

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.Options.md

Adds user credentials (username and optional password) to the NervesSSH options.

```APIDOC
## add_user

### Description

Add user credential to SSH options

### Method

`NervesSSH.Options.add_user/3`

### Parameters

#### Path Parameters

- **options** (t()) - Required - The current NervesSSH options struct.
- **username** (String.t()) - Required - The username for the credential.
- **password** (String.t() | nil) - Optional - The password for the user. If nil, no password is set.
```

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

### info

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.md

Retrieves and returns information about the running SSH daemon. This is useful for inspecting the current state and details of the SSH server.

```APIDOC
## info

### Description
Retrieves and returns information about the running SSH daemon. This is useful for inspecting the current state and details of the SSH server.

### Method
`NervesSSH.info/1`

### Parameters
#### Path Parameters
- **name** (GenServer.name()) - The name of the NervesSSH instance.

### Returns
- `{:ok, keyword()}` - Information about the SSH daemon on success.
- `{:error, :bad_daemon_ref}` - If the SSH daemon reference is invalid.
```

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

### Add User Credential

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.Options.md

Adds a username and optional password to the NervesSSH options.

```elixir
@spec add_user(t(), String.t(), String.t() | nil) :: t()
```

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

### Add Subsystem

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.Options.md

Adds an SSH subsystem specification to the NervesSSH options.

```elixir
@spec add_subsystem(t(), :ssh.subsystem_spec()) :: t()
```

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

### NervesSSH.Options Fields

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.Options.md

Defines the available fields for configuring the NervesSSH daemon. These options control various aspects of the SSH server's behavior.

```APIDOC
## NervesSSH.Options Fields

Defines option for running the SSH daemon.

The following fields are available:

* `:name` - a name used to reference the NervesSSH-managed SSH daemon. Defaults to `NervesSSH`.
* `:authorized_keys` - a list of SSH authorized key file string
* `:port` - the TCP port to use for the SSH daemon. Defaults to `22`.
* `:subsystems` - a list of [SSH subsystems specs](https://erlang.org/doc/man/ssh.html#type-subsystem_spec) to start. Defaults to SFTP and `ssh_subsystem_fwup`
* `:user_dir` - where to find authorized_keys file
* `:system_dir` - where to find host keys
* `:shell` - the language of the shell (`:elixir`, `:erlang`, `:lfe` or `:disabled`). Defaults to `:elixir`.
* `:exec` - the language to use for commands sent over ssh (`:elixir`, `:erlang`, or `:disabled`). Defaults to `:elixir`.
* `:iex_opts` - additional options to use when starting up IEx
* `:user_passwords` - a list of username/password tuples (stored in the clear!)
* `:daemon_option_overrides` - additional options to pass to `:ssh.daemon/2`. These take precedence and are unchecked. Be careful using this since it can break other options.
```

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

### check

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.UserPasswords.md

Checks user credentials against a set of allowed combinations. Allows a specified number of attempts before disconnecting.

```APIDOC
## check

### Description
Checks user credentials against a set of allowed combinations. Allows a specified number of attempts before disconnecting.

### Function Signature
```elixir
check(name :: GenServer.name(), username :: :erlang.string(), password :: :erlang.string(), port :: :ssh.ip_port(), max_attempts :: :undefined | non_neg_integer()) :: boolean() | :disconnect | {boolean(), non_neg_integer()}
```

### Parameters

*   **name** (:erlang.name) - The GenServer name to check against.
*   **username** (:erlang.string) - The username to authenticate.
*   **password** (:erlang.string) - The password for the username.
*   **port** (:ssh.ip_port) - The IP port associated with the connection.
*   **max_attempts** (:undefined | non_neg_integer()) - The maximum number of login attempts allowed. If :undefined, a default is used.

### Return Value

*   `boolean()` - True if the credentials are valid, false otherwise.
*   `:disconnect` - If the maximum number of attempts has been reached.
*   `{boolean(), non_neg_integer()}` - A tuple containing a boolean indicating validity and the remaining number of attempts.
```

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

### add_subsystem

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.Options.md

Adds an SSH subsystem specification to the NervesSSH options.

```APIDOC
## add_subsystem

### Description

Add a subsystem

### Method

`NervesSSH.Options.add_subsystem/2`

### Parameters

#### Path Parameters

- **options** (t()) - Required - The current NervesSSH options struct.
- **subsystem_spec** (:ssh.subsystem_spec()) - Required - The subsystem specification to add.
```

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

### Sanitize NervesSSH Options

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.Options.md

Cleans and corrects NervesSSH options to prevent potential crashes during SSH daemon startup.

```elixir
@spec sanitize(t()) :: t()
```

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

### Add SSH Public Key at Runtime

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.md

Add an SSH public key to the authorized keys list at runtime. This change is persisted to disk and will be effective after restarting the SSH daemon.

```elixir
iex> NervesSSH.add_authorized_key("ssh-ed25519 AAAAC3NzaC...")
```

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

### run_lfe

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.Exec.md

Executes a single LFE command over SSH and returns the result. It can return either a success tuple with the command's output or an error tuple with an error message.

```APIDOC
## `NervesSSH.Exec.run_lfe`

### Description
Runs a single LFE command over SSH.

### Function Signature
```elixir
run_lfe(charlist()) :: {:ok, iolist()} | {:error, binary()}
```

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response
- `{:ok, iolist()}`: The output of the executed LFE command.

#### Error Response
- `{:error, binary()}`: An error message if the command execution failed.

### Response Example
```json
{
  "example": "{:ok, [\"LFE output\", \"more output\"]}"
}
```

```json
{
  "example": "{:error, \"Command failed\"}"
}
```
```

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

### Configure Public Keys via Application Config

Source: https://nerves-ssh.hexdocs.pm/

Use this snippet to directly embed public SSH keys within your application's configuration. Ensure keys are correctly formatted.

```elixir
config :nerves_ssh,
  authorized_keys: [
    "ssh-rsa
    AAAAB3NzaC1yc2EAAAADAQABAAAAgQDBCdMwNo0xOE86il0DB2Tq4RCv07XvnV7W1uQBlOOE0ZZVjxmTIOiu8XcSLy0mHj11qX5pQH3Th6Jmyqdj",
    "ssh-rsa
    AAAAB3NzaC1yc2EAAAADAQABAAACAQCaf37TM8GfNKcoDjoewa6021zln4GvmOiXqW6SRpF61uNWZXurPte1u8frrJX1P/hGxCL7YN3cV6eZqRiF"
  ]
```

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

### NervesSSH Language Type

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.Options.md

Defines the possible languages for shell and exec options.

```elixir
@type language() :: :elixir | :erlang | :lfe | :disabled
```

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

### Save Authorized Keys

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.Options.md

Saves the current authorized keys to the authorized_keys file.

```elixir
@spec save_authorized_keys(t()) :: :ok | {:error, File.posix()}
```

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

### sanitize

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.Options.md

Sanitizes the NervesSSH options to ensure they are valid and will not cause the SSH daemon to crash.

```APIDOC
## sanitize

### Description

Go through the options and fix anything that might crash

The goal is to make options "always work" since it is painful to
debug typo's, etc. that cause the ssh daemon to not start.

### Method

`NervesSSH.Options.sanitize/1`

### Parameters

#### Path Parameters

- **options** (t()) - Required - The NervesSSH options struct to sanitize.
```

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

### Integrate NervesSSH into Supervision Tree

Source: https://nerves-ssh.hexdocs.pm/

Add NervesSSH as a child to your supervisor. Ensure that :nerves_ssh is not specified in your config.exs when using this method.

```elixir
{NervesSSH, nerves_ssh_options}
```

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

### Add Authorized Key

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.Options.md

Adds an SSH authorized key to the NervesSSH options.

```elixir
@spec add_authorized_key(t(), String.t()) :: t()
```

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

### add_authorized_key

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.Options.md

Adds an authorized SSH key to the NervesSSH options.

```APIDOC
## add_authorized_key

### Description

Add an authorized key

### Method

`NervesSSH.Options.add_authorized_key/2`

### Parameters

#### Path Parameters

- **options** (t()) - Required - The current NervesSSH options struct.
- **key** (String.t()) - Required - The SSH public key string to add.
```

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

### save_authorized_keys

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.Options.md

Saves the authorized keys from the NervesSSH options struct to the `authorized_keys` file.

```APIDOC
## save_authorized_keys

### Description

Save the authorized keys to authorized_keys file

### Method

`NervesSSH.Options.save_authorized_keys/1`

### Parameters

#### Path Parameters

- **options** (t()) - Required - The NervesSSH options struct.
```

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

### Run LFE Command via SSH

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.Exec.md

Executes a single LFE (Lisp Flavored Erlang) command over SSH. Returns an {:ok, iolist()} tuple on success or an {:error, binary()} tuple on failure.

```elixir
 @spec run_lfe(charlist()) :: {:ok, iolist()} | {:error, binary()}
```

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

### Run Elixir Command via SSH

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.Exec.md

Executes a single Elixir command over SSH. Returns an {:ok, binary()} tuple on success or an {:error, binary()} tuple on failure.

```elixir
 @spec run_elixir(charlist()) :: {:ok, binary()} | {:error, binary()}
```

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

### run_elixir

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.Exec.md

Executes a single Elixir command over SSH and returns the result. It can return either a success tuple with the command's output or an error tuple with an error message.

```APIDOC
## `NervesSSH.Exec.run_elixir`

### Description
Runs a single Elixir command over SSH.

### Function Signature
```elixir
run_elixir(charlist()) :: {:ok, binary()} | {:error, binary()}
```

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response
- `{:ok, binary()}`: The output of the executed Elixir command.

#### Error Response
- `{:error, binary()}`: An error message if the command execution failed.

### Response Example
```json
{
  "example": "{:ok, \"Elixir output\"}"
}
```

```json
{
  "example": "{:error, \"Command failed\"}"
}
```
```

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

### NervesSSH Options Struct Type

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.Options.md

Defines the structure of the NervesSSH.Options struct, outlining all configurable fields.

```elixir
@type t() :: %NervesSSH.Options{
  authorized_keys: [String.t()],
  daemon_option_overrides: keyword(),
  decoded_authorized_keys: [:public_key.public_key()],
  exec: language(),
  iex_opts: keyword(),
  name: GenServer.name(),
  port: non_neg_integer(),
  shell: language(),
  subsystems: [:ssh.subsystem_spec()],
  system_dir: Path.t(),
  user_dir: Path.t(),
  user_passwords: [{String.t(), String.t()}]
}
```

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

### add_authorized_key

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.md

Adds an SSH public key to the authorized keys for a given NervesSSH instance. This operation persists the key so it remains active after restarts. The current list of authorized keys can be retrieved using `NervesSSH.configuration/0`.

```APIDOC
## add_authorized_key

### Description
Adds an SSH public key to the authorized keys for a given NervesSSH instance. This operation persists the key so it remains active after restarts. The current list of authorized keys can be retrieved using `NervesSSH.configuration/0`.

### Method
`NervesSSH.add_authorized_key/1`

### Parameters
#### Path Parameters
- **ssh_key** (String.t()) - The SSH public key string to add.

### Request Example
```elixir
NervesSSH.add_authorized_key("ssh-ed25519 AAAAC3NzaC...")
```
```

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

### Add NervesSSH Dependency

Source: https://nerves-ssh.hexdocs.pm/

Add NervesSSH to your project's mix dependencies. This is required if you are not using :nerves_pack v0.4.0 or later.

```elixir
def deps do
  [
    {:nerves_ssh, "~> 0.1.0", targets: @all_targets}
  ]
end
```

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

### decode_authorized_keys

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.Options.md

Decodes the authorized keys from string format into Erlang public key format within the options struct.

```APIDOC
## decode_authorized_keys

### Description

Decode the authorized keys into Erlang public key format

### Method

`NervesSSH.Options.decode_authorized_keys/1`

### Parameters

#### Path Parameters

- **options** (t()) - Required - The NervesSSH options struct.
```

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

### NervesSSH User Password Check Signature

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.UserPasswords.md

This is the type specification for the `check` function in NervesSSH.UserPasswords. It outlines the expected arguments and return types for validating user credentials.

```elixir
 @spec check(
  name :: GenServer.name(),
  :erlang.string(),
  :erlang.string(),
  :ssh.ip_port(),
  :undefined | non_neg_integer()
) :: boolean() | :disconnect | {boolean(), non_neg_integer()}

```

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

### Decode Authorized Keys

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.Options.md

Decodes the authorized keys from string format into Erlang public key format within the options struct.

```elixir
@spec decode_authorized_keys(t()) :: t()
```

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

### remove_subsystem

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.md

Removes a subsystem from the SSH daemon configuration.

```APIDOC
## remove_subsystem

### Description
Removes a subsystem from the SSH daemon configuration.

### Function Signature
```elixir
remove_subsystem(GenServer.name(), charlist()) :: :ok | {:error, term()}
```

### Parameters
#### Path Parameters
- **gen_server_name** (GenServer.name()) - The name of the NervesSSH GenServer.
- **subsystem_name** (charlist()) - The name of the subsystem to remove.

### Returns
- **:ok** - If the subsystem was successfully removed.
- **{:error, term()}** - If an error occurred during removal.
```

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

### remove_subsystem

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.Options.md

Removes an SSH subsystem specification from the NervesSSH options.

```APIDOC
## remove_subsystem

### Description

Remove a subsystem

### Method

`NervesSSH.Options.remove_subsystem/2`

### Parameters

#### Path Parameters

- **options** (t()) - Required - The current NervesSSH options struct.
- **subsystem_name** (charlist()) - Required - The name of the subsystem to remove.
```

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

### Remove Subsystem

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.Options.md

Removes an SSH subsystem specification from the NervesSSH options.

```elixir
@spec remove_subsystem(
  t(),
  charlist()
) :: t()
```

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

### remove_user

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.Options.md

Removes user credentials from the NervesSSH options.

```APIDOC
## remove_user

### Description

Remove user credential from SSH options

### Method

`NervesSSH.Options.remove_user/2`

### Parameters

#### Path Parameters

- **options** (t()) - Required - The current NervesSSH options struct.
- **username** (String.t()) - Required - The username of the credential to remove.
```

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

### Remove User Credential

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.Options.md

Removes a user credential from the NervesSSH options.

```elixir
@spec remove_user(t(), String.t()) :: t()
```

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

### Remove SSH User

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.md

Removes a user credential from the SSH daemon. This operation is straightforward and returns :ok upon successful removal.

```elixir
remove_user(GenServer.name(), String.t()) :: :ok
```

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

### Remove Authorized Key

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.Options.md

Removes an SSH authorized key from the NervesSSH options.

```elixir
@spec remove_authorized_key(t(), String.t()) :: t()
```

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

### remove_authorized_key

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.md

Removes an SSH public key from the authorized keys list. It searches for an exact match and updates the `{USER_DIR}/authorized_keys` file.

```APIDOC
## remove_authorized_key

### Description
Removes an SSH public key from the authorized keys list. This function looks for an exact match and updates the `{USER_DIR}/authorized_keys` file to persist the change.

### Function Signature
```elixir
remove_authorized_key(GenServer.name(), String.t()) :: :ok
```

### Parameters
#### Path Parameters
- **gen_server_name** (GenServer.name()) - The name of the NervesSSH GenServer.
- **public_key** (String.t()) - The exact SSH public key string to remove.

### Returns
- **:ok** - If the key was successfully removed.
```

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

### remove_user

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.md

Removes a user credential from the SSH daemon.

```APIDOC
## remove_user

### Description
Removes a user credential from the SSH daemon.

### Function Signature
```elixir
remove_user(GenServer.name(), String.t()) :: :ok
```

### Parameters
#### Path Parameters
- **gen_server_name** (GenServer.name()) - The name of the NervesSSH GenServer.
- **username** (String.t()) - The username of the credential to remove.

### Returns
- **:ok** - If the user credential was successfully removed.
```

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

### remove_authorized_key

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.Options.md

Removes an authorized SSH key from the NervesSSH options.

```APIDOC
## remove_authorized_key

### Description

Remove an authorized key

### Method

`NervesSSH.Options.remove_authorized_key/2`

### Parameters

#### Path Parameters

- **options** (t()) - Required - The current NervesSSH options struct.
- **key** (String.t()) - Required - The SSH public key string to remove.
```

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

### Remove SSH Subsystem

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.md

Removes a subsystem from the SSH daemon configuration. This function can return an error if the subsystem is not found or cannot be removed.

```elixir
remove_subsystem(
  GenServer.name(),
  charlist()
) :: :ok | {:error, term()}
```

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

### Remove SSH Public Key

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.md

Removes an exact SSH public key from the authorized keys list. The user's authorized_keys file is updated to persist the change.

```elixir
remove_authorized_key(GenServer.name(), String.t()) :: :ok
```

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

### remove_user

Source: https://nerves-ssh.hexdocs.pm/NervesSSH.md

Removes a user credential from the SSH daemon. This operation is not persisted across restarts.

```APIDOC
## remove_user

### Description
Removes a user credential from the SSH daemon. This operation is not persisted across restarts.

### Method
`NervesSSH.remove_user/1`

### Parameters
#### Path Parameters
- **username** (String.t()) - The username of the credential to remove.
```
Tokens:
Raw