ssh_client_key

2012 2016 Ericsson AB, All Rights Reserved Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. The Initial Developer of the Original Code is Ericsson AB. ssh_client_key_api

ssh_client_key_api -behaviour(ssh_client_key_api).

Behavior describing the API for public key handling of an SSH client. By implementing the callbacks defined in this behavior, the public key handling of an SSH client can be customized. By default the ssh application implements this behavior with help of the standard OpenSSH files, see the ssh(6) application manual.

DATA TYPES

Type definitions that are used more than once in this module, or abstractions to indicate the intended use of the data type, or both. For more details on public key data types, refer to Section 2 Public Key Records in the public_key user's guide:

boolean() =

true | false

string() =

[byte()]

public_key() =

#'RSAPublicKey'{} | {integer(),#'Dss-Parms'{}} | {#'ECPoint'{},{namedCurve,Curve::string()}}

private_key() =

#'RSAPrivateKey'{} | #'DSAPrivateKey'{} | #'ECPrivateKey'{}

public_key_algorithm() =

Module:add_host_key(HostNames, Key, ConnectOptions) -> ok | {error, Reason} Adds a host key to the set of trusted host keys. HostNames = string() Description of the host that owns the PublicKey. Key = public_key() Normally an RSA, DSA or ECDSA public key, but handling of other public keys can be added. ConnectOptions = proplists:proplist() Options provided to ssh:connect/[3,4]. The option list given in the key_cb option is available with the key key_cb_private. Reason = term().

Adds a host key to the set of trusted host keys.

Module:is_host_key(Key, Host, Algorithm, ConnectOptions) -> Result Checks if a host key is trusted. Key = public_key() Normally an RSA, DSA or ECDSA public key, but handling of other public keys can be added. Host = string() Description of the host. Algorithm = public_key_algorithm() Host key algorithm. ConnectOptions = proplists:proplist() Options provided to ssh:connect/[3,4]. The option list given in the key_cb option is available with the key key_cb_private. Result = boolean()

Checks if a host key is trusted.

Module:user_key(Algorithm, ConnectOptions) -> {ok, PrivateKey} | {error, Reason} Fetches the users public key matching the Algorithm. Algorithm = public_key_algorithm() Host key algorithm. ConnectOptions = proplists:proplist() Options provided to ssh:connect/[3,4]. The option list given in the key_cb option is available with the key key_cb_private. PrivateKey = private_key() Private key of the user matching the Algorithm. Reason = term()

Fetches the users public key matching the Algorithm.

The private key contains the public key.