dropbear: INSTALL annotate

annotate INSTALL @ 1672:3a97f14c0235

Add Chacha20-Poly1305, AES128-GCM and AES256-GCM support (#93) * Add Chacha20-Poly1305 authenticated encryption * Add general AEAD approach. * Add [email protected] algo using LibTomCrypt chacha and poly1305 routines. Chacha20-Poly1305 is generally faster than AES256 on CPU w/o dedicated AES instructions, having the same key size. Compiling in will add ~5,5kB to binary size on x86-64. function old new delta chacha_crypt - 1397 +1397 _poly1305_block - 608 +608 poly1305_done - 595 +595 dropbear_chachapoly_crypt - 457 +457 .rodata 26976 27392 +416 poly1305_process - 290 +290 poly1305_init - 221 +221 chacha_setup - 218 +218 encrypt_packet 1068 1270 +202 dropbear_chachapoly_getlength - 147 +147 decrypt_packet 756 897 +141 chacha_ivctr64 - 137 +137 read_packet 543 637 +94 dropbear_chachapoly_start - 94 +94 read_kex_algos 792 880 +88 chacha_keystream - 69 +69 dropbear_mode_chachapoly - 48 +48 sshciphers 280 320 +40 dropbear_mode_none 24 48 +24 dropbear_mode_ctr 24 48 +24 dropbear_mode_cbc 24 48 +24 dropbear_chachapoly_mac - 24 +24 dropbear_chachapoly - 24 +24 gen_new_keys 848 854 +6 ------------------------------------------------------------------------------ (add/remove: 14/0 grow/shrink: 10/0 up/down: 5388/0) Total: 5388 bytes * Add AES128-GCM and AES256-GCM authenticated encryption * Add general AES-GCM mode. * Add [email protected] and [email protected] algo using LibTomCrypt gcm routines. AES-GCM is combination of AES CTR mode and GHASH, slower than AES-CTR on CPU w/o dedicated AES/GHASH instructions therefore disabled by default. Compiling in will add ~6kB to binary size on x86-64. function old new delta gcm_process - 1060 +1060 .rodata 26976 27808 +832 gcm_gf_mult - 820 +820 gcm_add_aad - 660 +660 gcm_shift_table - 512 +512 gcm_done - 471 +471 gcm_add_iv - 384 +384 gcm_init - 347 +347 dropbear_gcm_crypt - 309 +309 encrypt_packet 1068 1270 +202 decrypt_packet 756 897 +141 gcm_reset - 118 +118 read_packet 543 637 +94 read_kex_algos 792 880 +88 sshciphers 280 360 +80 gcm_mult_h - 80 +80 dropbear_gcm_start - 62 +62 dropbear_mode_gcm - 48 +48 dropbear_mode_none 24 48 +24 dropbear_mode_ctr 24 48 +24 dropbear_mode_cbc 24 48 +24 dropbear_ghash - 24 +24 dropbear_gcm_getlength - 24 +24 gen_new_keys 848 854 +6 ------------------------------------------------------------------------------ (add/remove: 14/0 grow/shrink: 10/0 up/down: 6434/0) Total: 6434 bytes

author	Vladislav Grishenko <themiron@users.noreply.github.com>
date	Mon, 25 May 2020 20:50:25 +0500
parents	986126448688
children	295377ecbf49

rev	line source
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	1 Basic Dropbear build instructions:
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	2
1493 72fd994fe7bd Update build instructions for localoptions, and tidy Matt Johnston <matt@ucc.asn.au> parents: 1447 diff changeset	3 - Edit localoptions.h to set which features you want. Available options
1524 d35cf9a5e0b5 rename default_options.h.in in docs too Matt Johnston <matt@ucc.asn.au> parents: 1493 diff changeset	4 are described in default_options.h, these will be overridden by
1493 72fd994fe7bd Update build instructions for localoptions, and tidy Matt Johnston <matt@ucc.asn.au> parents: 1447 diff changeset	5 anything set in localoptions.h
1565 2fd52c383163 mention localoptions.h being build directory, fix underscore in CHANGES Matt Johnston <matt@ucc.asn.au> parents: 1524 diff changeset	6 localoptions.h should be located in the build directory if you are
2fd52c383163 mention localoptions.h being build directory, fix underscore in CHANGES Matt Johnston <matt@ucc.asn.au> parents: 1524 diff changeset	7 building out of tree.
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	8
1493 72fd994fe7bd Update build instructions for localoptions, and tidy Matt Johnston <matt@ucc.asn.au> parents: 1447 diff changeset	9 - If using a Mercurial or Git checkout, "autoconf; autoheader"
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	10
1493 72fd994fe7bd Update build instructions for localoptions, and tidy Matt Johnston <matt@ucc.asn.au> parents: 1447 diff changeset	11 - Configure for your system:
72fd994fe7bd Update build instructions for localoptions, and tidy Matt Johnston <matt@ucc.asn.au> parents: 1447 diff changeset	12 ./configure (optionally with --disable-zlib or --disable-syslog,
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	13 or --help for other options)
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	14
1493 72fd994fe7bd Update build instructions for localoptions, and tidy Matt Johnston <matt@ucc.asn.au> parents: 1447 diff changeset	15 - Compile:
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	16
1493 72fd994fe7bd Update build instructions for localoptions, and tidy Matt Johnston <matt@ucc.asn.au> parents: 1447 diff changeset	17 make PROGRAMS="dropbear dbclient dropbearkey dropbearconvert scp"
72fd994fe7bd Update build instructions for localoptions, and tidy Matt Johnston <matt@ucc.asn.au> parents: 1447 diff changeset	18
72fd994fe7bd Update build instructions for localoptions, and tidy Matt Johnston <matt@ucc.asn.au> parents: 1447 diff changeset	19 - Optionally install, or copy the binaries another way
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	20
1493 72fd994fe7bd Update build instructions for localoptions, and tidy Matt Johnston <matt@ucc.asn.au> parents: 1447 diff changeset	21 make install (/usr/local/bin is usual default):
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	22
1493 72fd994fe7bd Update build instructions for localoptions, and tidy Matt Johnston <matt@ucc.asn.au> parents: 1447 diff changeset	23 or
72fd994fe7bd Update build instructions for localoptions, and tidy Matt Johnston <matt@ucc.asn.au> parents: 1447 diff changeset	24
72fd994fe7bd Update build instructions for localoptions, and tidy Matt Johnston <matt@ucc.asn.au> parents: 1447 diff changeset	25 make PROGRAMS="dropbear dbclient dropbearkey dropbearconvert scp" install
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	26
72 9597c2e3b9d4 Some doc changes Matt Johnston <matt@ucc.asn.au> parents: 69 diff changeset	27 (you can leave items out of the PROGRAMS list to avoid compiling them. If you
9597c2e3b9d4 Some doc changes Matt Johnston <matt@ucc.asn.au> parents: 69 diff changeset	28 recompile after changing the PROGRAMS list, you MUST "make clean" before
9597c2e3b9d4 Some doc changes Matt Johnston <matt@ucc.asn.au> parents: 69 diff changeset	29 recompiling - bad things will happen otherwise)
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	30
72 9597c2e3b9d4 Some doc changes Matt Johnston <matt@ucc.asn.au> parents: 69 diff changeset	31 See MULTI for instructions on making all-in-one binaries.
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	32
1447 8f88f4290b22 document --enable-static in place of STATIC=1 Matt Johnston <matt@ucc.asn.au> parents: 443 diff changeset	33 If you want to compile statically use ./configure --enable-static
8f88f4290b22 document --enable-static in place of STATIC=1 Matt Johnston <matt@ucc.asn.au> parents: 443 diff changeset	34
8f88f4290b22 document --enable-static in place of STATIC=1 Matt Johnston <matt@ucc.asn.au> parents: 443 diff changeset	35 By default Dropbear adds various build flags that improve robustness
1493 72fd994fe7bd Update build instructions for localoptions, and tidy Matt Johnston <matt@ucc.asn.au> parents: 1447 diff changeset	36 against programming bugs (good for security). If these cause problems
1447 8f88f4290b22 document --enable-static in place of STATIC=1 Matt Johnston <matt@ucc.asn.au> parents: 443 diff changeset	37 they can be disabled with ./configure --disable-harden
72 9597c2e3b9d4 Some doc changes Matt Johnston <matt@ucc.asn.au> parents: 69 diff changeset	38
443 2d943453cecf Fix spelling typo Matt Johnston <matt@ucc.asn.au> parents: 245 diff changeset	39 Binaries can be stripped with "make strip"
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	40
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	41 ============================================================================
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	42
245 b24730e11c83 add note about compiling for 386 Matt Johnston <matt@ucc.asn.au> parents: 72 diff changeset	43 If you're compiling for a 386-class CPU, you will probably need to add
b24730e11c83 add note about compiling for 386 Matt Johnston <matt@ucc.asn.au> parents: 72 diff changeset	44 CFLAGS=-DLTC_NO_BSWAP so that libtomcrypt doesn't use 486+ instructions.
b24730e11c83 add note about compiling for 386 Matt Johnston <matt@ucc.asn.au> parents: 72 diff changeset	45
b24730e11c83 add note about compiling for 386 Matt Johnston <matt@ucc.asn.au> parents: 72 diff changeset	46 ============================================================================
b24730e11c83 add note about compiling for 386 Matt Johnston <matt@ucc.asn.au> parents: 72 diff changeset	47
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	48 Compiling with uClibc:
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	49
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	50 Firstly, make sure you have at least uclibc 0.9.17, as getusershell() in prior
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	51 versions is broken. Also note that you may get strange issues if your uClibc
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	52 headers don't match the library you are running with, ie the headers might
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	53 say that shadow password support exists, but the libraries don't have it.
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	54
72 9597c2e3b9d4 Some doc changes Matt Johnston <matt@ucc.asn.au> parents: 69 diff changeset	55 Compiling for uClibc should be the same as normal, just set CC to the magic
9597c2e3b9d4 Some doc changes Matt Johnston <matt@ucc.asn.au> parents: 69 diff changeset	56 uClibc toolchain compiler (ie export CC=i386-uclibc-gcc or whatever).
9597c2e3b9d4 Some doc changes Matt Johnston <matt@ucc.asn.au> parents: 69 diff changeset	57 You can use "make STATIC=1" to make statically linked binaries, and it is
9597c2e3b9d4 Some doc changes Matt Johnston <matt@ucc.asn.au> parents: 69 diff changeset	58 advisable to strip the binaries too. If you're looking to make a small binary,
1667 986126448688 Update remaining advise to edit options.h Alexander Dahl <ada@thorsis.com> parents: 1565 diff changeset	59 you should remove unneeded ciphers and MD5, by editing localoptions.h
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	60
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	61 It is possible to compile zlib in, by copying zlib.h and zconf.h into a
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	62 subdirectory (ie zlibincludes), and
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	63
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	64 export CFLAGS="-Izlibincludes -I../zlibincludes"
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	65 export LDFLAGS=/usr/lib/libz.a
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	66
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	67 before ./configure and make.
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	68
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	69 If you disable zlib, you must explicitly disable compression for the client -
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	70 OpenSSH is possibly buggy in this regard, it seems you need to disable it
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	71 globally in ~/.ssh/config, not just in the host entry in that file.
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	72
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	73 You may want to manually disable lastlog recording when using uClibc, configure
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	74 with --disable-lastlog.
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	75
69 59d16db56e9f Simple text changes Matt Johnston <matt@ucc.asn.au> parents: 4 diff changeset	76 One common problem is pty allocation. There are a number of types of pty
59d16db56e9f Simple text changes Matt Johnston <matt@ucc.asn.au> parents: 4 diff changeset	77 allocation which can be used -- if they work properly, the end result is the
59d16db56e9f Simple text changes Matt Johnston <matt@ucc.asn.au> parents: 4 diff changeset	78 same for each type. Running configure should detect the best type to use
59d16db56e9f Simple text changes Matt Johnston <matt@ucc.asn.au> parents: 4 diff changeset	79 automatically, however for some systems, this may be incorrect. Some
59d16db56e9f Simple text changes Matt Johnston <matt@ucc.asn.au> parents: 4 diff changeset	80 things to note:
4 fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	81
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	82 If your system expects /dev/pts to be mounted (this is a uClibc option),
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	83 make sure that it is.
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	84
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	85 Make sure that your libc headers match the library version you are using.
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	86
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	87 If openpty() is being used (HAVE_OPENPTY defined in config.h) and it fails,
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	88 you can try compiling with --disable-openpty. You will probably then need
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	89 to create all the /dev/pty?? and /dev/tty?? devices, which can be
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	90 problematic for devfs. In general, openpty() is the best way to allocate
fe6bca95afa7 Makefile.in contains updated files required Matt Johnston <matt@ucc.asn.au> parents: diff changeset	91 PTYs, so it's best to try and get it working.

Mercurial > dropbear

annotate INSTALL @ 1672:3a97f14c0235