tools/OpenSSL-Query
Richard Levitte e31cc76864 Move OpenSSL-Query from omc-tools
Fixes #134

Co-authored-by: Matthias St. Pierre <matthias.st.pierre@ncp-e.com>

Reviewed-by: Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com>
Reviewed-by: Paul Dale <pauli@openssl.org>
(Merged from https://github.com/openssl/tools/pull/170)
2023-11-08 07:03:29 +01:00
..
lib/OpenSSL Move OpenSSL-Query from omc-tools 2023-11-08 07:03:29 +01:00
t Move OpenSSL-Query from omc-tools 2023-11-08 07:03:29 +01:00
MANIFEST Move OpenSSL-Query from omc-tools 2023-11-08 07:03:29 +01:00
Makefile.PL Move OpenSSL-Query from omc-tools 2023-11-08 07:03:29 +01:00
README.md Move OpenSSL-Query from omc-tools 2023-11-08 07:03:29 +01:00

README.md

OpenSSL::Query

A module to query certain information about OpenSSL committers as well as members of the OMC (OpenSSL Management Committee). These data are usually interesting for other programs that need to verify identities, whether a certain person holds a CLA, that sort of thing.

OpenSSL::Query is built to be able to handle several implementations for access to the databases that hold the data. The default implementation uses a RESTful API with JSON encoded responses, OpenSSL::Query::REST.

Requirements

OpenSSL::Query requires the following modules to build:

  • Module::Install (debian package libmodule-install-perl)

OpenSSL::Query requires these extra modules to run:

  • Class::Method::Modifiers (debian package libclass-method-modifiers-perl)
  • Moo (debian package libmoo-perl)
  • URI::Encode (debian package liburi-encode-perl)
  • LWP::UserAgent
  • LWP::Protocol::https

Any other module OpenSSL::Query depends on should be part of core perl.

On Debian, you can use the following command to install the required packages:

sudo apt install libmodule-install-perl libclass-method-modifiers-perl libmoo-perl liburi-encode-perl

Installation

perl Makefile.PL
make && sudo make install

Local installation

For a local installation, you might want to consider using local::lib (debian package liblocal-lib-perl). In that case, running Makefile.PL is slightly different:

perl -Mlocal::lib Makefile.PL

Other than that, follow the instructions in "Installation" above.

To get the paths right permanently, you might want to consider adding this in your .bash_profile, .bashrc och corresponding shell init script:

eval "`perl -I$HOME/perl5/lib/perl5 -Mlocal::lib`"

Testing

Testing is done like this:

make test

However, it requires the additional Perl module Dancer2 and plackup (debian packages libdancer2-perl and libplack-perl) and that a temporary query service is started as well. This is part of QueryApp, and is started like this:

here=`pwd`                # the directory OpenSSL-Query/
cd ../QueryApp            # Or wherever you have it checked out
PERSONDB=./t/query_data/pdb.yaml CLADB=./t/query_data/cdb.txt \
PERL5LIB=./lib:$here/lib plackup bin/query.psgi