From fc1155f97408c2b620659e3c37b600fbeae27246 Mon Sep 17 00:00:00 2001
From: Matt Johnston <matt@ucc.asn.au>
Date: Thu, 3 Oct 2013 23:45:25 +0800
Subject: [PATCH] Add manpage for dropbearconvert Move dropbearkey to manual
section 1 Add install target for manpages
--HG--
rename : dropbearkey.8 => dropbearkey.1
---
Makefile.in | 33 +++++++++++-----------
dropbearconvert.1 | 50 ++++++++++++++++++++++++++++++++++
dropbearkey.8 => dropbearkey.1 | 13 +++++----
3 files changed, 74 insertions(+), 22 deletions(-)
create mode 100644 dropbearconvert.1
rename dropbearkey.8 => dropbearkey.1 (71%)
diff --git a/Makefile.in b/Makefile.in
index 4bdd845e..ef39ca8e 100644
--- a/Makefile.in
+++ b/Makefile.in
@@ -66,9 +66,10 @@ VPATH=@srcdir@
srcdir=@srcdir@
prefix=@prefix@
-exec_prefix=${prefix}
-bindir=${exec_prefix}/bin
-sbindir=${exec_prefix}/sbin
+datarootdir = @datarootdir@
+bindir=@bindir@
+sbindir=@sbindir@
+mandir=@mandir@
CC=@CC@
AR=@AR@
@@ -123,33 +124,31 @@ install: $(addprefix inst_, $(TARGETS))
installdropbearmulti: insdbmulti $(addprefix insmulti, $(PROGRAMS))
insdbmulti: dropbearmulti
- $(INSTALL) -d -m 755 $(DESTDIR)$(bindir)
- $(INSTALL) -m 755 dropbearmulti$(EXEEXT) $(DESTDIR)$(bindir)
- -chown root $(DESTDIR)$(bindir)/dropbearmulti$(EXEEXT)
- -chgrp 0 $(DESTDIR)$(bindir)/dropbearmulti$(EXEEXT)
+ $(INSTALL) -d $(DESTDIR)$(bindir)
+ $(INSTALL) dropbearmulti$(EXEEXT) $(DESTDIR)$(bindir)
insmultidropbear: dropbearmulti
- $(INSTALL) -d -m 755 $(DESTDIR)$(sbindir)
+ $(INSTALL) -d $(DESTDIR)$(sbindir)
-rm -f $(DESTDIR)$(sbindir)/dropbear$(EXEEXT)
-ln -s $(bindir)/dropbearmulti$(EXEEXT) $(DESTDIR)$(sbindir)/dropbear$(EXEEXT)
insmulti%: dropbearmulti
- $(INSTALL) -d -m 755 $(DESTDIR)$(bindir)
+ $(INSTALL) -d $(DESTDIR)$(bindir)
-rm -f $(DESTDIR)$(bindir)/$*$(EXEEXT)
-ln -s $(bindir)/dropbearmulti$(EXEEXT) $(DESTDIR)$(bindir)/$*$(EXEEXT)
# dropbear should go in sbin, so it needs a seperate rule
inst_dropbear: dropbear
- $(INSTALL) -d -m 755 $(DESTDIR)$(sbindir)
- $(INSTALL) -m 755 dropbear$(EXEEXT) $(DESTDIR)$(sbindir)
- -chown root $(DESTDIR)$(sbindir)/dropbear$(EXEEXT)
- -chgrp 0 $(DESTDIR)$(sbindir)/dropbear$(EXEEXT)
+ $(INSTALL) -d $(DESTDIR)$(sbindir)
+ $(INSTALL) dropbear$(EXEEXT) $(DESTDIR)$(sbindir)
+ $(INSTALL) -d $(DESTDIR)$(mandir)/man8
+ $(INSTALL) -m 644 dropbear.8 $(DESTDIR)$(mandir)/man8/dropbear.8
inst_%: $*
- $(INSTALL) -d -m 755 $(DESTDIR)$(bindir)
- $(INSTALL) -m 755 $*$(EXEEXT) $(DESTDIR)$(bindir)
- -chown root $(DESTDIR)$(bindir)/$*$(EXEEXT)
- -chgrp 0 $(DESTDIR)$(bindir)/$*$(EXEEXT)
+ $(INSTALL) -d $(DESTDIR)$(bindir)
+ $(INSTALL) $*$(EXEEXT) $(DESTDIR)$(bindir)
+ $(INSTALL) -d $(DESTDIR)$(mandir)/man1
+ $(INSTALL) -m 644 $*.1 $(DESTDIR)$(mandir)/man1/$*.1
# for some reason the rule further down doesn't like $($@objs) as a prereq.
diff --git a/dropbearconvert.1 b/dropbearconvert.1
new file mode 100644
index 00000000..4643f5f9
--- /dev/null
+++ b/dropbearconvert.1
@@ -0,0 +1,50 @@
+.TH dropbearconvert 1
+.SH NAME
+dropbearconvert \- convert between Dropbear and OpenSSH private key formats
+.SH SYNOPSIS
+.B dropbearconvert
+.I input_type
+.I output_type
+.I input_file
+.I output_file
+.SH DESCRIPTION
+.B Dropbear
+and
+.B OpenSSH
+SSH implementations have different private key formats.
+.B dropbearconvert
+can convert between the two.
+.P
+Dropbear uses the same SSH public key format as OpenSSH, it can be extracted
+from a private key by using
+.B dropbearkey \-y
+.P
+Encrypted private keys are not supported, use ssh-keygen(1) to decrypt them
+first.
+.SH OPTIONS
+.TP
+.B input type
+Either
+.I dropbear
+or
+.I openssh
+.TP
+.B output type
+Either
+.I dropbear
+or
+.I openssh
+.TP
+.B input file
+An existing Dropbear or OpenSSH private key file
+.TP
+.B output file
+The path to write the converted private key file
+.SH EXAMPLE
+ # dropbearconvert openssh dropbear ~/.ssh/id_rsa ~/.ssh/dropbear_priv
+.SH AUTHOR
+Matt Johnston (matt@ucc.asn.au).
+.SH SEE ALSO
+ dropbearkey(1), ssh-keygen(1)
+.P
+https://matt.ucc.asn.au/dropbear/dropbear.html
diff --git a/dropbearkey.8 b/dropbearkey.1
similarity index 71%
rename from dropbearkey.8
rename to dropbearkey.1
index 953e02a6..945d4dad 100644
--- a/dropbearkey.8
+++ b/dropbearkey.1
@@ -1,6 +1,6 @@
-.TH dropbearkey 8
+.TH dropbearkey 1
.SH NAME
-dropbearkey \- create private keys for the use with dropbear(8)
+dropbearkey \- create private keys for the use with dropbear(8) or dbclient(1)
.SH SYNOPSIS
.B dropbearkey
\-t
@@ -16,8 +16,7 @@ generates a
or
.I DSS
format SSH private key, and saves it to a file for the use with the
-.BR dropbear (8)
-SSH 2 server.
+Dropbear client or server.
Note that
some SSH implementations
use the term "DSA" rather than "DSS", they mean the same thing.
@@ -38,6 +37,10 @@ Write the secret key to the file
Set the key size to
.I bits
bits, should be multiple of 8 (optional).
+.SH NOTES
+The program dropbearconvert(1) can be used to convert between Dropbear and OpenSSH key formats.
+.P
+Dropbear does not support encrypted keys.
.SH EXAMPLE
# dropbearkey -t rsa -f /etc/dropbear/dropbear_rsa_host_key
.SH AUTHOR
@@ -45,6 +48,6 @@ Matt Johnston (matt@ucc.asn.au).
.br
Gerrit Pape (pape@smarden.org) wrote this manual page.
.SH SEE ALSO
-dropbear(8), dbclient(1)
+dropbear(8), dbclient(1), dropbearconvert(1)
.P
https://matt.ucc.asn.au/dropbear/dropbear.html
--
GitLab