From 0fec46b68fef24849f4387702c8aa2b12d16f0ee Mon Sep 17 00:00:00 2001 From: Frantisek Hrbata Date: Mon, 4 Jan 2021 19:29:15 +0100 Subject: [PATCH] doc: add gimrr-register-krb and gimrr-server-krb doc Signed-off-by: Frantisek Hrbata --- Documentation/gimrr-register-krb.txt | 53 +++++++++++++++++++++++++++++++ Documentation/gimrr-server-krb.txt | 58 ++++++++++++++++++++++++++++++++++ Documentation/git-mr.txt | 2 ++ 3 files changed, 113 insertions(+) create mode 100644 Documentation/gimrr-register-krb.txt create mode 100644 Documentation/gimrr-server-krb.txt diff --git a/Documentation/gimrr-register-krb.txt b/Documentation/gimrr-register-krb.txt new file mode 100644 index 0000000..c6dba50 --- /dev/null +++ b/Documentation/gimrr-register-krb.txt @@ -0,0 +1,53 @@ +GIMRR-REGISTER-KRB(1) +===================== +:doctype: manpage + + +NAME +---- +gimrr-register-krb - Register public key on server using Kerberos authentication + + +SYNOPSIS +-------- +*gimrr-register-krb* ['OPTIONS'] + + +DESCRIPTION +----------- +In network environment, where Kerberos authentication is already in place, +'gimrr-register-krb' can be used, along with +link:gimrr-server-krb.html[gimrr-server-krb(1)], to add gimrr user public key +under user's Kerberos name to 'authorized_keys' on server. + + +OPTIONS +------- +*--server* 'ADDR':: + Connect to server at ADDR for registration. + +*--port* 'PORT':: + Server port (default: 9876). + +*--timeout* 'SECONDS':: + Socket timeout for server's reply (default: 3). + +*--principal* 'PRINCIPAL':: + Kerberos principal name in primary/instance@REALM format. + For example HTTP/my.server.com@SERVER.COM + +*-k, --key* 'FILE':: + Path to the public key to use for registration. + +EXAMPLES +-------- +`$ ssh-keygen -t rsa -C "gimrr" -f ~/.ssh/gimrr`:: + Generate new keys. + +`$ gimrr-register-krb --principal host/server.com -k ~/.ssh/gimrr.pub --server server.com`:: + Register gimrr.pub key at server.com. + + +SEE ALSO +-------- +link:git-mr.html[git-mr(1)] diff --git a/Documentation/gimrr-server-krb.txt b/Documentation/gimrr-server-krb.txt new file mode 100644 index 0000000..a10784d --- /dev/null +++ b/Documentation/gimrr-server-krb.txt @@ -0,0 +1,58 @@ +GIMRR-SERVER-KRB(1) +=================== +:doctype: manpage + + +NAME +---- +gimrr-server-krb - Server for adding gimrr users public keys using Kerberos authentication + + +SYNOPSIS +-------- +*gimrr-server-krb* ['OPTIONS'] + + +DESCRIPTION +----------- +Simple server using gssapi to authenticate Kerberos users and add their public +keys to the ssh 'authorized_keys' file. + + +OPTIONS +------- +*--address* 'ADDR':: + Bind server to ADDR (default: INADDR_ANY). + +*--port* 'PORT':: + Listen at specified port (default: 9876). + +*--timeout* 'SECONDS':: + Socket timeout for client connections (default: 3 sec.) + +*--principal* 'PRINCIPAL':: + Kerberos principal name in primary/instance@REALM format. + For example HTTP/my.server.com@SERVER.COM + +*--keytab* 'FILE':: + Keytab with key for server principal (default: /etc/krb5.keytab) + +*--auth-keys* 'FILE':: + Ssh authorized_keys file where to store public keys. + +*--daemon*:: + Start server as daemon in background. + +*--log* 'FILE':: + Server log file. + + +EXAMPLES +-------- +`$ gimrr-server-krb --keytab krb5.keytab --principal host/server.com --auth-keys ~/.ssh/authorized_keys --log ~/gimrr-krb.log --daemon`:: + Start server under the gimrr user account as described at link:git-mr.html[git-mr(1)] in section *SERVER SETUP*. + + +SEE ALSO +-------- +link:git-mr.html[git-mr(1)] diff --git a/Documentation/git-mr.txt b/Documentation/git-mr.txt index 2e6f0d6..e8e7937 100644 --- a/Documentation/git-mr.txt +++ b/Documentation/git-mr.txt @@ -328,3 +328,5 @@ link:git-mr-reply.html[git-mr-reply(1)] link:git-mr-merge.html[git-mr-merge(1)] link:git-mr-comment-list.html[git-mr-comment-list(1)] link:git-mr-comment-show.html[git-mr-comment-show(1)] +link:gimrr-server-krb.html[gimrr-server-krb(1)] +link:gimrr-register-krb.html[gimrr-register-krb(1)] -- 1.7.10.4