From 871e450ebff145c06ae4fef0889f5310d0fb46b4 Mon Sep 17 00:00:00 2001
From: Gustav Simonsson <gustav@erlang-solutions.com>
Date: Mon, 13 Feb 2012 11:36:41 +0100
Subject: Add behaviour (api) module with callback specs

Function parameter and return type specifications
for the public key functions
---
 lib/ssh/src/Makefile        |  5 ++++-
 lib/ssh/src/ssh.app.src     |  1 +
 lib/ssh/src/ssh_file.erl    |  2 ++
 lib/ssh/src/ssh_key_api.erl | 45 +++++++++++++++++++++++++++++++++++++++++++++
 4 files changed, 52 insertions(+), 1 deletion(-)
 create mode 100644 lib/ssh/src/ssh_key_api.erl

(limited to 'lib/ssh')

diff --git a/lib/ssh/src/Makefile b/lib/ssh/src/Makefile
index cd9618c139..7be97abf66 100644
--- a/lib/ssh/src/Makefile
+++ b/lib/ssh/src/Makefile
@@ -36,7 +36,11 @@ RELSYSDIR = $(RELEASE_PATH)/lib/ssh-$(VSN)
 # Common Macros
 # ----------------------------------------------------
 
+# Behaviour (api) modules are first so they are compiled when
+# the compiler reaches a callback module using them.
 MODULES= \
+	ssh_sftpd_file_api \
+	ssh_key_api \
 	ssh \
 	ssh_sup \
 	sshc_sup \
@@ -63,7 +67,6 @@ MODULES= \
 	ssh_sftp \
 	ssh_sftpd \
 	ssh_sftpd_file\
-	ssh_sftpd_file_api \
 	ssh_transport \
 	ssh_userreg \
 	ssh_xfer
diff --git a/lib/ssh/src/ssh.app.src b/lib/ssh/src/ssh.app.src
index 154c72485e..7a58dbe54f 100644
--- a/lib/ssh/src/ssh.app.src
+++ b/lib/ssh/src/ssh.app.src
@@ -21,6 +21,7 @@
 	     sshd_sup,
 	     ssh_file,
 	     ssh_io,
+             ssh_key_api,
 	     ssh_math,
 	     ssh_no_io,
 	     ssh_sftp,
diff --git a/lib/ssh/src/ssh_file.erl b/lib/ssh/src/ssh_file.erl
index 97ebf77e82..8569051bee 100644
--- a/lib/ssh/src/ssh_file.erl
+++ b/lib/ssh/src/ssh_file.erl
@@ -23,6 +23,8 @@
 
 -module(ssh_file).
 
+-behaviour(ssh_key_api).
+
 -include_lib("public_key/include/public_key.hrl").
 -include_lib("kernel/include/file.hrl").
 
diff --git a/lib/ssh/src/ssh_key_api.erl b/lib/ssh/src/ssh_key_api.erl
new file mode 100644
index 0000000000..8085c12e21
--- /dev/null
+++ b/lib/ssh/src/ssh_key_api.erl
@@ -0,0 +1,45 @@
+%%
+%% %CopyrightBegin%
+%%
+%% Copyright Ericsson AB 2011-2012. All Rights Reserved.
+%%
+%% The contents of this file are subject to the Erlang Public License,
+%% Version 1.1, (the "License"); you may not use this file except in
+%% compliance with the License. You should have received a copy of the
+%% Erlang Public License along with this software. If not, it can be
+%% retrieved online at http://www.erlang.org/.
+%%
+%% Software distributed under the License is distributed on an "AS IS"
+%% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
+%% the License for the specific language governing rights and limitations
+%% under the License.
+%%
+%% %CopyrightEnd%
+%%
+
+-module(ssh_key_api).
+
+-include_lib("public_key/include/public_key.hrl"). 
+-include("ssh.hrl").
+
+-type ssh_algorithm() :: string().
+-type file_error()    :: file:posix() | badarg | system_limit | terminated.
+
+-callback host_key(Algorithm :: ssh_algorithm(), Options :: list()) -> 
+                      {ok, [{public_key(), Attributes::list()}]} | public_key()
+                          | {error, string()}.
+
+-callback user_key(Algorithm :: ssh_algorithm(), Options :: list()) -> 
+                     {ok, [{public_key(), Attributes::list()}]} | public_key()
+                          | {error, string()}.
+
+-callback is_host_key(Key :: public_key(), PeerName :: string(), 
+                  Algorithm :: ssh_algorithm(), Options :: list()) ->
+                         boolean().
+
+-callback add_host_key(Host :: string(), Key :: public_key(), Options :: list()) ->
+                          ok | {error, file_error()}.
+
+-callback is_auth_key(Key :: public_key(), User :: string(),
+                  Algorithm :: ssh_algorithm(), Options :: list()) ->
+                         boolean().
-- 
cgit v1.2.3