ssh-agent 0.1.0 · OCaml Package

module Privkey : sig ... end

module Pubkey : sig ... end

type identity = {

pubkey : Pubkey.t;
comment : string;

}

val sexp_of_identity : identity -> Ppx_sexp_conv_lib.Sexp.t

type sign_flag =

| SSH_AGENT_RSA_SHA2_256
| SSH_AGENT_RSA_SHA2_512

Flags for what hashing algorithm is desired when doing a signing request. * SHA1 is assumed otherwise.

val sexp_of_sign_flag : sign_flag -> Ppx_sexp_conv_lib.Sexp.t

type key_constraint =

| Lifetime of int32
| Confirm

val sexp_of_key_constraint : key_constraint -> Ppx_sexp_conv_lib.Sexp.t

type ssh_agent_request_type = [

| `Ssh_agentc_request_identities
| `Ssh_agentc_sign_request
| `Ssh_agentc_extension
| `Ssh_agentc_successable

]

ssh_agent_request_type is used in the below GADTs for enforcing protocol * semantics. It represents types of requests. The `Ssh_agentc_successable * type is a generalization of all requests that expect either success or * failure.

type _ ssh_agent_request =

| Ssh_agentc_request_identities : [ `Ssh_agentc_request_identities ] ssh_agent_request
| Ssh_agentc_add_identity : {
1. privkey : Privkey.t;
2. key_comment : string;
} -> [ `Ssh_agentc_successable ] ssh_agent_request
| Ssh_agentc_remove_identity : Pubkey.t -> [ `Ssh_agentc_successable ] ssh_agent_request
| Ssh_agentc_remove_all_identities : [ `Ssh_agentc_successable ] ssh_agent_request
| Ssh_agentc_add_smartcard_key : {
1. smartcard_id : string;
2. smartcard_pin : string;
} -> [ `Ssh_agentc_successable ] ssh_agent_request
| Ssh_agentc_remove_smartcard_key : {
1. smartcard_reader_id : string;
2. smartcard_reader_pin : string;
} -> [ `Ssh_agentc_successable ] ssh_agent_request
| Ssh_agentc_lock : string -> [ `Ssh_agentc_successable ] ssh_agent_request
| Ssh_agentc_unlock : string -> [ `Ssh_agentc_successable ] ssh_agent_request
| Ssh_agentc_add_id_constrained : {
1. privkey : Privkey.t;
2. key_comment : string;
3. key_constraints : key_constraint list;
} -> [ `Ssh_agentc_successable ] ssh_agent_request
| Ssh_agentc_add_smartcard_key_constrained : {
1. smartcard_id : string;
2. smartcard_pin : string;
3. smartcard_constraints : key_constraint list;
} -> [ `Ssh_agentc_successable ] ssh_agent_request
| Ssh_agentc_extension : {
1. extension_type : string;
2. extension_contents : string;
} -> [ `Ssh_agentc_extension ] ssh_agent_request

val sexp_of_ssh_agent_request : 
  ('v_x__001_ -> Ppx_sexp_conv_lib.Sexp.t) ->
  'v_x__001_ ssh_agent_request ->
  Ppx_sexp_conv_lib.Sexp.t

type any_ssh_agent_request =

| Any_request : 'a ssh_agent_request -> any_ssh_agent_request

val sexp_of_any_ssh_agent_request : 
  any_ssh_agent_request ->
  Ppx_sexp_conv_lib.Sexp.t

type _ ssh_agent_response =

| Ssh_agent_failure : [< ssh_agent_request_type ] ssh_agent_response
| Ssh_agent_success : [ `Ssh_agentc_successable ] ssh_agent_response
| Ssh_agent_extension_failure : [ `Ssh_agentc_extension ] ssh_agent_response
| Ssh_agent_extension_blob : string -> [ `Ssh_agentc_extension ] ssh_agent_response
(*
Generic uninterpreted response - it's up to the library user to interpret * the message body.
*)
| Ssh_agent_identities_answer : identity list -> [ `Ssh_agentc_request_identities ] ssh_agent_response
| Ssh_agent_sign_response : string -> [ `Ssh_agentc_sign_request ] ssh_agent_response

val sexp_of_ssh_agent_response : 
  ('v_x__002_ -> Ppx_sexp_conv_lib.Sexp.t) ->
  'v_x__002_ ssh_agent_response ->
  Ppx_sexp_conv_lib.Sexp.t

type any_ssh_agent_response =

| Any_response : 'a ssh_agent_response -> any_ssh_agent_response

val sexp_of_any_ssh_agent_response : 
  any_ssh_agent_response ->
  Ppx_sexp_conv_lib.Sexp.t

type request_handler = {

handle : 'a. 'a ssh_agent_request -> 'a ssh_agent_response;

}

Any function that takes a request and returns a valid response for the * request type

module Parse : sig ... end

module Serialize : sig ... end

val is_extension_request : 'a ssh_agent_request -> bool

is_extension_request request returns true if request is * Ssh_agentc_extension. Useful for passing ~extension to * ssh_agent_message.

val unpack_any_response : 
  'a ssh_agent_request ->
  any_ssh_agent_response ->
  ('a ssh_agent_response, string) Stdlib.result

unpack_any_response request response unpacks response if it is a valid * response type with regard to request, otherwise Error is returned.

val sign : 
  Privkey.t ->
  Ssh_agent__.Protocol_number.sign_flag list ->
  string ->
  string

sign privkey flags blob returns a signature of blob using privkey * respecting the hashing algorithms specified by flags. Currently, only RSA * signatures are supported.

package ssh-agent