https://github.com/noloader/cryptopp-autotools
Autotools files for Crypto++ project
https://github.com/noloader/cryptopp-autotools
autotools c-plus-plus wei-dai-crypto
Last synced: about 1 year ago
JSON representation
Autotools files for Crypto++ project
- Host: GitHub
- URL: https://github.com/noloader/cryptopp-autotools
- Owner: noloader
- Created: 2017-11-01T14:33:38.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-10-02T07:19:42.000Z (over 2 years ago)
- Last Synced: 2025-03-24T18:45:23.378Z (about 1 year ago)
- Topics: autotools, c-plus-plus, wei-dai-crypto
- Language: M4
- Size: 669 KB
- Stars: 9
- Watchers: 10
- Forks: 6
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Crypto++ Autotools
[](https://travis-ci.org/noloader/cryptopp-autotools)
[](https://ci.appveyor.com/project/noloader/cryptopp-autotools)
This repository contains Autotools files for Wei Dai's Crypto++ (https://github.com/weidai11/cryptopp). It supplies `configure.ac`, `makefile.am` and `libcryptopp.pc.in`. Autotools is officialy unsupported, so use it at your own risk.
The purpose of Crypto++ Autotools is three-fold:
1. better support Linux distributions, like Debain, Fedora and openSUSE
2. supplement the GNUmakefile which is reaching its limits with repsect to GNUmake-based configuration
3. utilize compiler feature probes that produce better results on ARM, MIPS and Power8 architectures
The initial `Makefile.am` and `configure.ac` were shamelessly ripped from Debian. Many thanks to László Böszörményi for his work on the files and allowing us to use them as a starting point. Nick Bowler and Mathieu Lirzin from the Automake mailing list were extremely helpful in porting our requirements to Automake.
There is a wiki page available that discusses Autotools and the Crypto++ project files in more detail at [Autotools](https://www.cryptopp.com/wiki/Autotools).
## Documentation
The Autotools project files are documented on the [Crypto++ wiki | Autotools](https://www.cryptopp.com/wiki/Autotools). If there is an error or ommission in the wiki article, then please fix it or open a bug report.
## Testing
The Autotools files are officialy unsupported, so use them at your own risk. With that said, the Autotools source files are tested with Crypto++ on Linux and OS X using [Travis CI](https://github.com/weidai11/cryptopp/blob/master/.travis.yml).
In June 2018 the library added `cryptest-autotools.sh` to help test the Autotools gear. The script is located in Crypto++'s `TestScripts` directory. The script downloads the Autotools project files, builds the library and then runs the self tests.
If you want to use `cryptest-autotools.sh` to drive things then perform the following steps.
cd cryptopp
cp TestScripts/cryptest-autotools.sh .
./cryptest-autotools.sh
## Workflow
The general workflow is clone Wei Dai's Crypto++, fetch the Autotools files, and then `autoreconf`:
git clone https://github.com/weidai11/cryptopp.git
cd cryptopp
wget -O configure.ac https://raw.githubusercontent.com/noloader/cryptopp-autotools/master/bootstrap.sh
wget -O configure.ac https://raw.githubusercontent.com/noloader/cryptopp-autotools/master/configure.ac
wget -O Makefile.am https://raw.githubusercontent.com/noloader/cryptopp-autotools/master/Makefile.am
wget -O libcryptopp.pc.in https://raw.githubusercontent.com/noloader/cryptopp-autotools/master/libcryptopp.pc.in
mkdir -p "$PWD/m4/"
Once you have the files you can run `bootstrap.sh`. `bootstrap.sh` performs the necessary preamble and also runs `autoupdate`. Our testing showed `autoupdate` produced bad results on some versions of Autotools, so it is hit or miss whether it should be run.
./bootstrap.sh
./configure
make
make test
sudo make install
Best performance is obtained with `-O3` because GCC (and other compiler) apply vectorization optimizations. If you are not forced to `-O2` by policy (like Debian or Fedora), then you should configure with a higher optimization enabled:
CPPFLAGS="-DNDEBUG" CXXFLAGS="-g2 -O3" ./configure
Despite our efforts we have not been able to add the submodule to Crypto++ for seamless integration. If anyone knows how to add a submodule directly to the Crypto++ directory, then please provide the instructions.
## ZIP Files
If you are working from a Crypto++ release zip file, then you should download the same cryptopp-autotools release zip file. Both Crypto++ and this project use the same release tags, such as CRYPTOPP_8_0_0.
If you mix and match Master with a release zip file then things may not work as expected. You may find the build project files reference a source file that is not present in the Crypto++ release.
## Prerequisites
Before running the Autotools project please ensure you have the following installed:
1. autoupdate
2. autoconf and autoreconf
3. automake
4. libtool
You may also need `libltdl-dev` on Debian and Ubuntu; and may need `libtool-ltdl-devel` on Fedora. MinGW and family need the Autoconf and Automake *wrappers* in addition to the Autoconf and Automake binaries.
If working on the GCC Compile Farm then you may need exta steps for systems like AIX. AIX offers updated Autoconf and Automake in `/opt/freeware/bin/`; and offers Libtool in `/opt/cfarm/libtool-2.4.2/bin/`. Both `bin/` need to be on path. When running `autoreconf` you must `autoreconf --force --install --include=/opt/cfarm/libtool-2.4.2/share/aclocal/`.
## Integration
The Autotools submodule integrates with the Crypto++ library. The submodule removes the library's `GNUmakefile` and `GNUmakefile-cross`. In the future we plan to overwrite the library's `config.h` and produce an installation specific `config.h`.
The library's `GNUmakefile` and `GNUmakefile-cross` were modified to clean the artifacts produced by Autotools. To clean the directory after running Autotools perform a `git checkout GNUmakefile` followed by a `make -f GNUmakefile distclean`.
## Cross-compiles
Cross-compiles may work. The biggest problem seems to be libtool and shared object naming. Autotools fails to produce a shared object on platforms like Android.
## Collaboration
We would like all distro maintainers to be collaborators on this repo. If you are a distro maintainer then please contact us so we can send you an invite.
If you are a collaborator then make changes as you see fit. You don't need to ask for permission to make a change. Noloader is not an Autotools expert so there are probably lots of opportunities for improvement.
Keep in mind other distros may be using the files, so try not to break things for the other guy. We have to be mindful of lesser-used platforms and compilers, like AIX, Solaris, IBM xlC and Oracle's SunCC.
## License
Everything in this repo is release under Public Domain code. If the license or terms is unpalatable for you, then don't feel obligated to use it or commit.