Skip to contentSkip to conversation

add library xmlsec1

PATCH New Bastian Breit 3 participants 5 messages Feb 9, 2019 – Feb 10, 2019

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 add library xmlsec1

---
 package/Config.in                  |  1 +
 package/libxmlsec1/COPYING         |  1 +
 package/libxmlsec1/Config.in       | 11 +++++++++++
 package/libxmlsec1/libxmlsec1.hash |  1 +
 package/libxmlsec1/libxmlsec1.mk   | 17 +++++++++++++++++
 5 files changed, 31 insertions(+)
 create mode 100644 package/libxmlsec1/COPYING
 create mode 100644 package/libxmlsec1/Config.in
 create mode 100644 package/libxmlsec1/libxmlsec1.hash
 create mode 100644 package/libxmlsec1/libxmlsec1.mk
package/Config.in +1 -0
index 29862c478c..18acfd9db8 100644
@@ -1428,6 +1428,7 @@ menu "JSON/XML"
 	source "package/libxml2/Config.in"
 	source "package/libxmlpp/Config.in"
 	source "package/libxmlrpc/Config.in"
+	source "package/libxmlsec1/Config.in"
 	source "package/libxslt/Config.in"
 	source "package/libyaml/Config.in"
 	source "package/mxml/Config.in"
package/libxmlsec1/COPYING new file +1 -0
new file mode 100644
index 0000000000..9f0da96c81
@@ -0,0 +1 @@
+prop lic do not copy
package/libxmlsec1/Config.in new file +11 -0
new file mode 100644
index 0000000000..836d4db674
@@ -0,0 +1,11 @@
+config BR2_PACKAGE_LIBXMLSEC1
+	bool "libxmlsec1"
+	select BR2_PACKAGE_LIBXML2
+	select BR2_PACKAGE_LIBXSLT
+	select BR2_PACKAGE_OPENSSL
+	help
+	XMLSec library provides C based implementation for major XML
+	Security standards:
+	- XML Signature Syntax and Processing
+	- XML Encryption Syntax and Processing
+	https://www.aleksey.com/xmlsec/
package/libxmlsec1/libxmlsec1.hash new file +1 -0
new file mode 100644
index 0000000000..ce44e23ac5
@@ -0,0 +1 @@
+md5  508bee7e4f1b99f2d50aaa7d38ede56e  xmlsec1-1.2.27.tar.gz
package/libxmlsec1/libxmlsec1.mk new file +17 -0
new file mode 100644
index 0000000000..6bf8944f1e
@@ -0,0 +1,17 @@
+LIBXMLSEC1_VERSION = 1.2.27
+LIBXMLSEC1_SOURCE = xmlsec1-${LIBXMLSEC1_VERSION}.tar.gz
+LIBXMLSEC1_SITE = http://www.aleksey.com/xmlsec/download
+LIBXMLSEC1_INSTALL_STAGING = YES
+LIBXMLSEC1_INSTALL_TARGET = YES
+LIBXMLSEC1_LICENSE = MIT
+LIBXMLSEC1_LICENSE_FILES = Copyright
+
+LIBXMLSEC1_CONF_OPTS += --disable-static
+LIBXMLSEC1_CONF_OPTS += --enable-crypto-dl=no
+LIBXMLSEC1_CONF_OPTS += --with-openssl=${STAGING_DIR}/usr
+LIBXMLSEC1_CONF_OPTS += --with-libxslt=no
+LIBXMLSEC1_CONF_OPTS += --with-gnutls=no
+LIBXMLSEC1_CONF_OPTS += --with-gcrypt=no
+LIBXMLSEC1_DEPENDENCIES = libxml2 libxslt openssl
+
+$(eval $(autotools-package))
Signature · 1 line
2.17.1
#1 lore raw

PATCH 1/1 add library xmlsec1

Hello Bastian,

Thanks for your contribution!

First of all, the commit title should be:

package/xmlsec1: new package

Quoted 3 lines · On Sat, 9 Feb 2019 22:53:51 +0100 Bastian Breit <[email protected]> wrote:
---
 package/Config.in                  |  1 +
 package/libxmlsec1/COPYING         |  1 +

What is this file about ?

Quoted 4 lines
 package/libxmlsec1/Config.in       | 11 +++++++++++
 package/libxmlsec1/libxmlsec1.hash |  1 +
 package/libxmlsec1/libxmlsec1.mk   | 17 +++++++++++++++++
 5 files changed, 31 insertions(+)

Please add an entry to the DEVELOPERS file for this package.

Quoted 7 lines
package/libxmlsec1/Config.in new file +1 -0
new file mode 100644
index 0000000000..836d4db674
@@ -0,0 +1,11 @@
+config BR2_PACKAGE_LIBXMLSEC1

package/libxmlsec1/Config.in line 11

Quoted 10 lines
package/libxmlsec1/Config.in new file +10 -0
+	bool "libxmlsec1"
+	select BR2_PACKAGE_LIBXML2
+	select BR2_PACKAGE_LIBXSLT
+	select BR2_PACKAGE_OPENSSL
+	help
+	XMLSec library provides C based implementation for major XML
+	Security standards:
+	- XML Signature Syntax and Processing
+	- XML Encryption Syntax and Processing
+	https://www.aleksey.com/xmlsec/

The indentation of the help is text is one tab + two spaces, and there should be one blank line before the upstream URL of the project.

Could you make sure to run "make check-package" ? This validates some basic coding styles rules in packages.

package/libxmlsec1/libxmlsec1.hash line 1

Quoted 7 lines
package/libxmlsec1/libxmlsec1.hash new file +1 -0
new file mode 100644
index 0000000000..ce44e23ac5
@@ -0,0 +1 @@
+md5  508bee7e4f1b99f2d50aaa7d38ede56e  xmlsec1-1.2.27.tar.gz

Where does this hash comes from ? Please add a comment above it that says where it was from. If it was locally calculated, then use a sha256 hash instead, and say so:

# Locally calculated
sha256 .... xmlsec1-1.2.27.tar.gz

If you found this md5 on the upstream website, then say so, and also include a locally calculated sha256 hash:

# From http://somewhere.com
md5 ... xmlsec1-1.2.27.tar.gz
# Locally calculated
sha256 ... xmlsec1-1.2.27.tar.gz

And finally, add a hash for the license file.

package/libxmlsec1/libxmlsec1.mk

Quoted 6 lines
package/libxmlsec1/libxmlsec1.mk new file +0 -0
new file mode 100644
index 0000000000..6bf8944f1e
@@ -0,0 +1,17 @@

Please include the typical comment header that we have in all package .mk files.

package/libxmlsec1/libxmlsec1.mk line 2

Quoted 2 lines
package/libxmlsec1/libxmlsec1.mk new file +2 -0
+LIBXMLSEC1_VERSION = 1.2.27
+LIBXMLSEC1_SOURCE = xmlsec1-${LIBXMLSEC1_VERSION}.tar.gz

Please use $(...) instead of ${...}

package/libxmlsec1/libxmlsec1.mk line 5

Quoted 3 lines
package/libxmlsec1/libxmlsec1.mk new file +3 -0
+LIBXMLSEC1_SITE = http://www.aleksey.com/xmlsec/download
+LIBXMLSEC1_INSTALL_STAGING = YES
+LIBXMLSEC1_INSTALL_TARGET = YES

This line is not needed, as it is the default.

package/libxmlsec1/libxmlsec1.mk line 9

Quoted 4 lines
package/libxmlsec1/libxmlsec1.mk new file +4 -0
+LIBXMLSEC1_LICENSE = MIT
+LIBXMLSEC1_LICENSE_FILES = Copyright
+
+LIBXMLSEC1_CONF_OPTS += --disable-static

Please don't pass --disable-static. Passing --{enable,disable}-{static,shared} is automatically done by the autotools-package infrastructure.

package/libxmlsec1/libxmlsec1.mk line 11

Quoted 2 lines
package/libxmlsec1/libxmlsec1.mk new file +2 -0
+LIBXMLSEC1_CONF_OPTS += --enable-crypto-dl=no
+LIBXMLSEC1_CONF_OPTS += --with-openssl=${STAGING_DIR}/usr

Use $(...) instead of ${...}

package/libxmlsec1/libxmlsec1.mk line 12

Quoted 1 line
package/libxmlsec1/libxmlsec1.mk new file +1 -0
+LIBXMLSEC1_CONF_OPTS += --with-libxslt=no

Why ? You have a dependency on libxslt. Also, if this dependency is not mandatory, it should be made optional.

package/libxmlsec1/libxmlsec1.mk line 14

Quoted 2 lines
package/libxmlsec1/libxmlsec1.mk new file +2 -0
+LIBXMLSEC1_CONF_OPTS += --with-gnutls=no
+LIBXMLSEC1_CONF_OPTS += --with-gcrypt=no

So OpenSSL is not mandatory and GnuTLS or GCrypt could be used ? If that is the case, then it should be supported.

package/libxmlsec1/libxmlsec1.mk line 17

Quoted 3 lines
package/libxmlsec1/libxmlsec1.mk new file +3 -0
+LIBXMLSEC1_DEPENDENCIES = libxml2 libxslt openssl
+
+$(eval $(autotools-package))

Could you rework your package to address those comments ?

Thanks a lot!

Thomas

Signature · 3 lines
Thomas Petazzoni, CTO, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
#2 lore raw

PATCH 1/1 add library xmlsec1

Hello Thomas,

Quoted 11 lines
Quoted 1 line

+LIBXMLSEC1_CONF_OPTS += --with-libxslt=no

Why ? You have a dependency on libxslt. Also, if this dependency is not mandatory, it should be made optional.

package/libxmlsec1/libxmlsec1.mk line 14

Quoted 2 lines
package/libxmlsec1/libxmlsec1.mk new file +2 -0
+LIBXMLSEC1_CONF_OPTS += --with-gnutls=no
+LIBXMLSEC1_CONF_OPTS += --with-gcrypt=no

So OpenSSL is not mandatory and GnuTLS or GCrypt could be used ? If that is the case, then it should be supported.

Quoted 7 lines

package/libxmlsec1/libxmlsec1.mk line 17

Quoted 3 lines
package/libxmlsec1/libxmlsec1.mk new file +3 -0
+LIBXMLSEC1_DEPENDENCIES = libxml2 libxslt openssl
+
+$(eval $(autotools-package))

Could you rework your package to address those comments ?

Thanks a lot!

I locally fixed the formatting and licence part.
I had some trouble with the mailing list and will use bastian.breit.buildroot at gmail.com from now on. We use libxmlsec1 in this context and haven't used another configuration. I am not sure, how the library works in other configuration. I would create config options for each option based on that list at
https://www.aleksey.com/xmlsec/faq.html
Should I send changes for formatting & licences with a different patch or should I send an all in one patch?

Sincerely

Bastian

#3 lore raw

PATCH 1/1 add library xmlsec1

Hello Bastian,

Quoted 1 line · On Sun, 10 Feb 2019 15:12:48 +0100 Bastian Breit…

I locally fixed the formatting and licence part.

Great, thanks!

Quoted 2 lines

I had some trouble with the mailing list and will use bastian.breit.buildroot at gmail.com from now on.

Which trouble did you encounter ?

Quoted 5 lines

We use libxmlsec1 in
this context and haven't used another configuration. I am not sure, how the library works in other configuration. I would create config options for each option based on that list at
https://www.aleksey.com/xmlsec/faq.html

No you don't have to support all options. If you don't support an option (like gnutls or gcrypt), then do like you did: disable support for it explicitly in the .mk file.

Quoted 2 lines

Should I send changes for formatting & licences with a different patch or should I send an all in one patch?

Send all in one patch, labeled as "v2", with a changelog below the "---" sign:

git format-patch -v2 HEAD^

Edit the 0001-...patch file, and below the --- sign, add some notes that explains what you changed since v1.

Thanks!

Thomas

Signature · 3 lines
Thomas Petazzoni, CTO, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
#4 lore raw

PATCH 1/1 add library xmlsec1

Hello Thomas

Quoted 1 line

Which trouble did you encounter ?

Too much emails to my main account. I therefore was not sure how to answer to the mailinglist, but it seemed to work. Therefore git send-email needed the password in the gitconfig. I also wanted to better seperate opensource & private account. So everything is fine now.

Quoted 3 lines

No you don't have to support all options. If you don't support an option (like gnutls or gcrypt), then do like you did: disable support for it explicitly in the .mk file.

in the faqs, there seems to be problems with other libraries. Maybe we will try out gnutls, then I will push changes upstream.

Quoted 7 lines

Send all in one patch, labeled as "v2", with a changelog below the "---" sign:

git format-patch -v2 HEAD^

Edit the 0001-...patch file, and below the --- sign, add some notes that explains what you changed since v1.

Okay.
Sincerely

Bastian