Skip to contentSkip to conversation

package/libopenssl: add option to enable some features

PATCH New Erwan Gautron 2 participants 2 messages Jul 21, 2020 – Aug 29, 2020

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 package/libopenssl: add option to enable some features

From: "GAUTRON, Erwan" <[email protected]>

Openssl implements lot of algorithms that are not required in some emdedded devices and cyphers known as weak.
Secure embedded systems shall disable unused algorithms (and weak algo) in order to be certified.
This patch allows to select weak algorithms and mecanims to enable such as md5
To ensure backward compatibility, all items are selected by default

---
 package/libopenssl/Config.in     | 147 +++++++++++++++++++++++++++++++
 package/libopenssl/libopenssl.mk |  24 +++++
 2 files changed, 171 insertions(+)
package/libopenssl/Config.in +147 -0
index 8909e36b9e..c034408a96 100644
@@ -44,4 +44,151 @@ config BR2_PACKAGE_LIBOPENSSL_ENGINES
 	help
 	  Install additional encryption engine libraries.
 
+config BR2_PACKAGE_LIBOPENSSL_ENABLE_CHACHA
+	bool "enable CHACHA "
+	default y
+	help
+	  Enable CHACHA cipher.
+
+config BR2_PACKAGE_LIBOPENSSL_ENABLE_RC5
+	bool "enable RC5"
+	default y
+	help
+	  Enable RC5 cipher.
+
+config BR2_PACKAGE_LIBOPENSSL_ENABLE_RC2
+	bool "enable RC2"
+	default y
+	help
+	  Enable RC2 cipher.
+
+config BR2_PACKAGE_LIBOPENSSL_ENABLE_RC4
+	bool "enable RC4"
+	default y
+	help
+	  Enable RC4 cipher.
+
+config BR2_PACKAGE_LIBOPENSSL_ENABLE_MD2
+	bool "enable MD2"
+	default y
+	help
+	  Enable MD2 cipher.
+
+config BR2_PACKAGE_LIBOPENSSL_ENABLE_MD4
+	bool "enable MD4"
+	default y
+	help
+	  Enable MD4 cipher.
+
+config BR2_PACKAGE_LIBOPENSSL_ENABLE_MD5
+	bool "enable MD5"
+	default y
+	help
+	  Enable MD5 cipher.
+
+config BR2_PACKAGE_LIBOPENSSL_ENABLE_MDC2
+	bool "enable MDC2"
+	default y
+	help
+	  Enable MDC2 cipher.
+
+config BR2_PACKAGE_LIBOPENSSL_ENABLE_BLAKE2
+	bool "enable BLAKE2"
+	default y
+	help
+	  Enable BLAKE2 cipher.
+
+config BR2_PACKAGE_LIBOPENSSL_ENABLE_IDEA
+	bool "enable IDEA"
+	default y
+	help
+	  Enable IDEA cipher.
+
+config BR2_PACKAGE_LIBOPENSSL_ENABLE_SEED
+	bool "enable SEED"
+	default y
+	help
+	  Enable SEED cipher.
+
+config BR2_PACKAGE_LIBOPENSSL_ENABLE_DES
+	bool "enable DES"
+	default y
+	help
+	  Enable DES cipher.
+
+config BR2_PACKAGE_LIBOPENSSL_ENABLE_RMD160
+	bool "enable RMD160"
+	default y
+	help
+	  Enable RMD160 cipher.
+
+config BR2_PACKAGE_LIBOPENSSL_ENABLE_WHIRLPOOL
+	bool "enable WHIRLPOOL"
+	default y
+	help
+	  Enable WHIRLPOOL cipher.
+
+config BR2_PACKAGE_LIBOPENSSL_ENABLE_BLOWFISH
+	bool "enable BLOWFISH"
+	default y
+	help
+	  Enable BLOWFISH cipher.
+
+config BR2_PACKAGE_LIBOPENSSL_ENABLE_SSL
+	bool "enable SSL"
+	default y
+	help
+	  Enable SSL mode.
+
+config BR2_PACKAGE_LIBOPENSSL_ENABLE_SSL2
+	bool "enable SSL2"
+	default y
+	help
+	  Enable SSL2 mode.
+
+config BR2_PACKAGE_LIBOPENSSL_ENABLE_SSL3
+	bool "enable SSL3"
+	default y
+	help
+	  Enable SSL3 mode.
+
+config BR2_PACKAGE_LIBOPENSSL_ENABLE_WEAK_SSL
+	bool "enable WEAK_SSL"
+	default y
+	help
+	  Enable WEAK_SSL mode.
+
+config BR2_PACKAGE_LIBOPENSSL_ENABLE_PSK
+	bool "enable mode PSK"
+	default y
+	help
+	  Enable PSK mode.
+
+config BR2_PACKAGE_LIBOPENSSL_ENABLE_CAST
+	bool "enable mode CAST"
+	default y
+	help
+	  Enable CAST mode.
+
+config BR2_PACKAGE_LIBOPENSSL_UNSECURE
+	bool "enable unit test, debug, backtrace"
+	default y
+	help
+	  Enable unit-test crypto-mdebug-backtrace
+	  crypto-mdebug autoerrinit mode.
+
+config BR2_PACKAGE_LIBOPENSSL_DYNAMIC_ENGINE
+	bool "enable dynamic engine"
+	default y
+	help
+	  Enable dynamic engine.
+
+
+config BR2_PACKAGE_LIBOPENSSL_ENABLE_COMP
+	bool "enable compression"
+	default y
+	help
+	  Enable compression.
+
+
 endif # BR2_PACKAGE_LIBOPENSSL
package/libopenssl/libopenssl.mk +24 -0
index a300458f85..ff9ae08d74 100644
@@ -86,6 +86,30 @@ define LIBOPENSSL_CONFIGURE_CMDS
 			no-tests \
 			no-fuzz-libfuzzer \
 			no-fuzz-afl \
+			$(if $(BR2_PACKAGE_LIBOPENSSL_ENABLE_CHACHA),,no-chacha) \
+			$(if $(BR2_PACKAGE_LIBOPENSSL_ENABLE_RC5),,no-rc5) \
+			$(if $(BR2_PACKAGE_LIBOPENSSL_ENABLE_RC2),,no-rc2) \
+			$(if $(BR2_PACKAGE_LIBOPENSSL_ENABLE_RC4),,no-rc4) \
+			$(if $(BR2_PACKAGE_LIBOPENSSL_ENABLE_MD2),,no-md2) \
+			$(if $(BR2_PACKAGE_LIBOPENSSL_ENABLE_MD4),,no-md4) \
+			$(if $(BR2_PACKAGE_LIBOPENSSL_ENABLE_MD5),,no-md5) \
+			$(if $(BR2_PACKAGE_LIBOPENSSL_ENABLE_MDC2),,no-mdc2) \
+			$(if $(BR2_PACKAGE_LIBOPENSSL_ENABLE_BLAKE2),,no-blake2) \
+			$(if $(BR2_PACKAGE_LIBOPENSSL_ENABLE_IDEA),,no-idea) \
+			$(if $(BR2_PACKAGE_LIBOPENSSL_ENABLE_SEED),,no-seed) \
+			$(if $(BR2_PACKAGE_LIBOPENSSL_ENABLE_DES),,no-des) \
+			$(if $(BR2_PACKAGE_LIBOPENSSL_ENABLE_RMD160),,no-rmd160) \
+			$(if $(BR2_PACKAGE_LIBOPENSSL_ENABLE_WHIRLPOOL),,no-whirlpool) \
+			$(if $(BR2_PACKAGE_LIBOPENSSL_ENABLE_BLOWFISH),,no-bf) \
+			$(if $(BR2_PACKAGE_LIBOPENSSL_ENABLE_SSL),,no-ssl) \
+			$(if $(BR2_PACKAGE_LIBOPENSSL_ENABLE_SSL2),,no-ssl2) \
+			$(if $(BR2_PACKAGE_LIBOPENSSL_ENABLE_SSL3),,no-ssl3) \
+			$(if $(BR2_PACKAGE_LIBOPENSSL_ENABLE_WEAK_SSL),,no-weak-ssl-ciphers) \
+			$(if $(BR2_PACKAGE_LIBOPENSSL_ENABLE_PSK),,no-psk) \
+			$(if $(BR2_PACKAGE_LIBOPENSSL_ENABLE_CAST),,no-cast) \
+			$(if $(BR2_PACKAGE_LIBOPENSSL_UNSECURE),,no-unit-test no-crypto-mdebug-backtrace no-crypto-mdebug no-autoerrinit) \
+			$(if $(BR2_PACKAGE_LIBOPENSSL_DYNAMIC_ENGINE),,no-dynamic-engine ) \
+			$(if $(BR2_PACKAGE_LIBOPENSSL_ENABLE_COMP),,no-comp) \
 			$(if $(BR2_STATIC_LIBS),zlib,zlib-dynamic) \
 	)
 	$(SED) "s#-march=[-a-z0-9] ##" -e "s#-mcpu=[-a-z0-9] ##g" $(@D)/Makefile
Signature · 1 line
2.25.1
#1 lore raw

PATCH 1/1 package/libopenssl: add option to enable some features

Erwan, All,

On 2020-07-21 11:26 +0200, Erwan Gautron spake thusly:

Quoted 8 lines

From: "GAUTRON, Erwan" <[email protected]>
Openssl implements lot of algorithms that are not required in some emdedded devices and cyphers known as weak.
Secure embedded systems shall disable unused algorithms (and weak algo) in order to be certified.
This patch allows to select weak algorithms and mecanims to enable such as md5
To ensure backward compatibility, all items are selected by default

While I certainly understand and appreciate the rationale, I think this is going a bit too far and is too granular.

I would suggest that we just add a few categories, like:

    config BR2_PACKAGE_LIBOPENSSL_LEGACY_CIPHERS
        bool "enable legacy cipher suites"
        help
          Build support for the following legacy, weak cipher suites:
            rc2
            rc4
            rc5
            [etc... fill in as appropriate]

    config BR2_PACKAGE_LIBOPENSSL_LEGACY_HASHES
        bool "enable legacy hash algorithms"
        help
          Build support for legacy, weak hash alorithms:
            md2
            md4
            md5
            [etc... fill in as appropriate]

    config BR2_PACKAGE_LIBOPENSSL_LEGACY_PROTOCOLS
        bool "enable legacy protocols"
        help
          Build support for legacy protocols;
            SSL 1.0
            SSL 2.0
            SSL 3.0
            TLS 1.0
            [etc... fill in as appropriate]

And we would consider legacy any cipher suite, hash algorithm, or protocol that is deprecated by NIST (e.g. because they are forbidden in FIPS 140-2, or the soon-to-be-in-force FIPS 140-3).

Finally, I would not add any option to disable "current" cipher suites, hash algorithms, or protocols; I would always have them built. This will help build devices that are future-proof, when the servers they talk to are upgraded to using new protocols and thus new cipher suites: devices in the fields will not need to be updated just for that.

Also, see below for a few generic comments...

Quoted 11 lines
---
 package/libopenssl/Config.in     | 147 +++++++++++++++++++++++++++++++
 package/libopenssl/libopenssl.mk |  24 +++++
 2 files changed, 171 insertions(+)
package/libopenssl/Config.in +0 -0
index 8909e36b9e..c034408a96 100644

package/libopenssl/Config.in config BR2_PACKAGE_LIBOPENSSL_ENGINES · line 51

Quoted 8 lines
package/libopenssl/Config.in +5 -0
@@ -44,4 +44,151 @@ config BR2_PACKAGE_LIBOPENSSL_ENGINES
 	help
 	  Install additional encryption engine libraries.
 
+config BR2_PACKAGE_LIBOPENSSL_ENABLE_CHACHA
+	bool "enable CHACHA "
+	default y
+	help
+	  Enable CHACHA cipher.

There is not point in providing a help text that just repeats the prompt of the option. Surely, the user expects to enable 'foo' when they select the 'foo' option, so a help text that just says so is useless. And in this case, there is no need for such a helpt text indeed.

But with the proposal I made above, that comment is now moot (but you'll know for your next patches! ;-) ).

Quoted 7 lines
package/libopenssl/Config.in +7 -0
+config BR2_PACKAGE_LIBOPENSSL_ENABLE_RC5
+	bool "enable RC5"
+	default y
+	help
+	  Enable RC5 cipher.
+
+config BR2_PACKAGE_LIBOPENSSL_ENABLE_RC2

package/libopenssl/Config.in config BR2_PACKAGE_LIBOPENSSL_ENGINES · line 69

Quoted 10 lines
package/libopenssl/Config.in +10 -0
+	bool "enable RC2"
+	default y
+	help
+	  Enable RC2 cipher.
+
+config BR2_PACKAGE_LIBOPENSSL_ENABLE_RC4
+	bool "enable RC4"
+	default y
+	help
+	  Enable RC4 cipher.

Also for the future: keep alphabetical ordering, so that items in a same category are ordered and easy to find.

package/libopenssl/Config.in config BR2_PACKAGE_LIBOPENSSL_ENGINES · line 75

Quoted 5 lines
package/libopenssl/Config.in +5 -0
+config BR2_PACKAGE_LIBOPENSSL_ENABLE_MD2
+	bool "enable MD2"
+	default y
+	help
+	  Enable MD2 cipher.

The MD2/4/5 are not ciphers, but hashes. Well, they are hash algorithms. Well, they are message-digest algorithms. Well, I am not a security pedant, but they are certainly not ciphers.

Quoted 13 lines
package/libopenssl/Config.in +13 -0
+config BR2_PACKAGE_LIBOPENSSL_ENABLE_SSL
+	bool "enable SSL"
+	default y
+	help
+	  Enable SSL mode.
+
+config BR2_PACKAGE_LIBOPENSSL_ENABLE_SSL2
+	bool "enable SSL2"
+	default y
+	help
+	  Enable SSL2 mode.
+
+config BR2_PACKAGE_LIBOPENSSL_ENABLE_SSL3

package/libopenssl/Config.in config BR2_PACKAGE_LIBOPENSSL_ENGINES · line 159

Quoted 10 lines
package/libopenssl/Config.in +10 -0
+	bool "enable SSL3"
+	default y
+	help
+	  Enable SSL3 mode.
+
+config BR2_PACKAGE_LIBOPENSSL_ENABLE_WEAK_SSL
+	bool "enable WEAK_SSL"
+	default y
+	help
+	  Enable WEAK_SSL mode.

WEAK_SSL is about weak ciphers; it's not a protocol, just the list of ciphers allowed.

Quoted 16 lines
package/libopenssl/Config.in +16 -0
+config BR2_PACKAGE_LIBOPENSSL_ENABLE_PSK
+	bool "enable mode PSK"
+	default y
+	help
+	  Enable PSK mode.
+
+config BR2_PACKAGE_LIBOPENSSL_ENABLE_CAST
+	bool "enable mode CAST"
+	default y
+	help
+	  Enable CAST mode.
+
+config BR2_PACKAGE_LIBOPENSSL_UNSECURE
+	bool "enable unit test, debug, backtrace"
+	default y
+	help

package/libopenssl/Config.in config BR2_PACKAGE_LIBOPENSSL_ENGINES · line 186

Quoted 10 lines
package/libopenssl/Config.in +10 -0
+	  Enable unit-test crypto-mdebug-backtrace
+	  crypto-mdebug autoerrinit mode.
+
+config BR2_PACKAGE_LIBOPENSSL_DYNAMIC_ENGINE
+	bool "enable dynamic engine"
+	default y
+	help
+	  Enable dynamic engine.
+
+

Two empty consecutive lines is one too many.

Running 'make check-package' would hint at this.

package/libopenssl/Config.in config BR2_PACKAGE_LIBOPENSSL_ENGINES · line 193

Quoted 7 lines
package/libopenssl/Config.in +7 -0
+config BR2_PACKAGE_LIBOPENSSL_ENABLE_COMP
+	bool "enable compression"
+	default y
+	help
+	  Enable compression.
+
+

Ditto empty lines.

Would you care to respin your series in the direction I suggest above, please?

Regards,
Yann E. MORIN.

Signature · 6 lines
.-----------------.--------------------.------------------.--------------------.
|  Yann E. MORIN  | Real-Time Embedded | /"\ ASCII RIBBON | Erics' conspiracy: |
| +33 662 376 056 | Software  Designer | \ / CAMPAIGN     |  ___               |
| +33 561 099 427 `------------.-------:  X  AGAINST      |  \e/  There is no  |
| http://ymorin.is-a-geek.org/ | _/*\_ | / \ HTML MAIL    |   v   conspiracy.  |
'------------------------------^-------^------------------^--------------------'