Mercurial > dropbear
annotate README @ 75:a54d20c96178
Some documentation touchups
| author | Matt Johnston <matt@ucc.asn.au> |
|---|---|
| date | Sat, 14 Aug 2004 17:59:42 +0000 |
| parents | 9597c2e3b9d4 |
| children | c2ac796b130e |
| rev | line source |
|---|---|
| 72 | 1 This is Dropbear, a smallish SSH 2 server and client. |
|
4
fe6bca95afa7
Makefile.in contains updated files required
Matt Johnston <matt@ucc.asn.au>
parents:
diff
changeset
|
2 |
|
fe6bca95afa7
Makefile.in contains updated files required
Matt Johnston <matt@ucc.asn.au>
parents:
diff
changeset
|
3 INSTALL has compilation instructions. |
|
fe6bca95afa7
Makefile.in contains updated files required
Matt Johnston <matt@ucc.asn.au>
parents:
diff
changeset
|
4 |
|
fe6bca95afa7
Makefile.in contains updated files required
Matt Johnston <matt@ucc.asn.au>
parents:
diff
changeset
|
5 MULTI has instructions on making a multi-purpose binary (ie a single binary |
|
fe6bca95afa7
Makefile.in contains updated files required
Matt Johnston <matt@ucc.asn.au>
parents:
diff
changeset
|
6 which performs multiple tasks, to save disk space) |
|
fe6bca95afa7
Makefile.in contains updated files required
Matt Johnston <matt@ucc.asn.au>
parents:
diff
changeset
|
7 |
|
fe6bca95afa7
Makefile.in contains updated files required
Matt Johnston <matt@ucc.asn.au>
parents:
diff
changeset
|
8 SMALL has some tips on creating small binaries. |
|
fe6bca95afa7
Makefile.in contains updated files required
Matt Johnston <matt@ucc.asn.au>
parents:
diff
changeset
|
9 |
|
fe6bca95afa7
Makefile.in contains updated files required
Matt Johnston <matt@ucc.asn.au>
parents:
diff
changeset
|
10 See TODO for a few of the things I know need looking at, and please contact |
|
fe6bca95afa7
Makefile.in contains updated files required
Matt Johnston <matt@ucc.asn.au>
parents:
diff
changeset
|
11 me if you have any questions/bugs found/features/ideas/comments etc :) |
|
fe6bca95afa7
Makefile.in contains updated files required
Matt Johnston <matt@ucc.asn.au>
parents:
diff
changeset
|
12 |
|
fe6bca95afa7
Makefile.in contains updated files required
Matt Johnston <matt@ucc.asn.au>
parents:
diff
changeset
|
13 Matt Johnston |
|
fe6bca95afa7
Makefile.in contains updated files required
Matt Johnston <matt@ucc.asn.au>
parents:
diff
changeset
|
14 [email protected] |
| 72 | 15 |
| 75 | 16 |
| 17 In the absence of detailed documentation, some notes follow: | |
| 72 | 18 ============================================================================ |
| 19 | |
| 20 Public key auth: | |
| 21 | |
| 22 You can use ~/.ssh/authorized_keys in the same way as with OpenSSH, just put | |
| 23 the key entries in that file. They should be of the form: | |
| 24 | |
| 25 ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAIEAwVa6M6cGVmUcLl2cFzkxEoJd06Ub4bVDsYrWvXhvUV+ZAM9uGuewZBDoAqNKJxoIn0Hyd0Nk/yU99UVv6NWV/5YSHtnf35LKds56j7cuzoQpFIdjNwdxAN0PCET/MG8qyskG/2IE2DPNIaJ3Wy+Ws4IZEgdJgPlTYUBWWtCWOGc= someone@hostname | |
| 26 | |
| 27 You must make sure that ~/.ssh, and the key file, are only writable by the | |
| 28 user. | |
| 29 | |
| 30 NOTE: Dropbear ignores authorized_keys options such as those described in the | |
| 31 OpenSSH sshd manpage, and will not allow a login for these keys. | |
| 32 | |
| 75 | 33 ============================================================================ |
| 34 | |
| 35 If you want to get the public-key portion of a Dropbear private key, look at | |
| 36 dropbearkey's '-y' option. | |
| 37 | |
| 38 ============================================================================ | |
| 39 | |
| 72 | 40 To run the server, you need to generate server keys, this is one-off: |
| 41 ./dropbearkey -t rsa -f dropbear_rsa_host_key | |
| 42 ./dropbearkey -t dss -f dropbear_dss_host_key | |
| 43 | |
| 44 or alternatively convert OpenSSH keys to Dropbear: | |
| 45 ./dropbearconvert openssh dropbear /etc/ssh/ssh_host_dsa_key dropbear_dss_host_key | |
| 46 | |
| 75 | 47 ============================================================================ |
| 72 | 48 |
| 49 If the server is run as non-root, you most likely won't be able to allocate a | |
| 50 pty, and you cannot login as any user other than that running the daemon | |
| 51 (obviously). Shadow passwords will also be unusable as non-root. | |
| 52 | |
| 75 | 53 ============================================================================ |
| 54 | |
| 72 | 55 The Dropbear distribution includes a standalone version of OpenSSH's scp |
| 56 program. You can compile it with "make scp", you may want to change the path | |
| 57 of the ssh binary, specified near the top of the scp.c file. By default | |
| 75 | 58 the progress meter isn't compiled in to save space, you can enable it by |
| 59 adding 'SCPPROGRESS=1' to the make commandline. |