diff options
Diffstat (limited to 'openssl/client')
| -rw-r--r-- | openssl/client/options.cxx | 673 | ||||
| -rw-r--r-- | openssl/client/options.hxx | 150 | ||||
| -rw-r--r-- | openssl/client/options.ixx | 90 |
3 files changed, 913 insertions, 0 deletions
diff --git a/openssl/client/options.cxx b/openssl/client/options.cxx new file mode 100644 index 0000000..c0a2c7f --- /dev/null +++ b/openssl/client/options.cxx @@ -0,0 +1,673 @@ +// -*- C++ -*- +// +// This file was generated by CLI, a command line interface +// compiler for C++. +// + +// Begin prologue. +// +#include <openssl/types-parsers.hxx> +// +// End prologue. + +#include <openssl/client/options.hxx> + +#include <map> +#include <set> +#include <string> +#include <vector> +#include <utility> +#include <ostream> +#include <sstream> +#include <cstring> + +namespace openssl +{ + namespace cli + { + template <typename X> + struct parser + { + static void + parse (X& x, bool& xs, scanner& s) + { + using namespace std; + + const char* o (s.next ()); + if (s.more ()) + { + string v (s.next ()); + istringstream is (v); + if (!(is >> x && is.peek () == istringstream::traits_type::eof ())) + throw invalid_value (o, v); + } + else + throw missing_value (o); + + xs = true; + } + }; + + template <> + struct parser<bool> + { + static void + parse (bool& x, bool& xs, scanner& s) + { + const char* o (s.next ()); + + if (s.more ()) + { + const char* v (s.next ()); + + if (std::strcmp (v, "1") == 0 || + std::strcmp (v, "true") == 0 || + std::strcmp (v, "TRUE") == 0 || + std::strcmp (v, "True") == 0) + x = true; + else if (std::strcmp (v, "0") == 0 || + std::strcmp (v, "false") == 0 || + std::strcmp (v, "FALSE") == 0 || + std::strcmp (v, "False") == 0) + x = false; + else + throw invalid_value (o, v); + } + else + throw missing_value (o); + + xs = true; + } + }; + + template <> + struct parser<std::string> + { + static void + parse (std::string& x, bool& xs, scanner& s) + { + const char* o (s.next ()); + + if (s.more ()) + x = s.next (); + else + throw missing_value (o); + + xs = true; + } + }; + + template <typename X> + struct parser<std::pair<X, std::size_t> > + { + static void + parse (std::pair<X, std::size_t>& x, bool& xs, scanner& s) + { + x.second = s.position (); + parser<X>::parse (x.first, xs, s); + } + }; + + template <typename X> + struct parser<std::vector<X> > + { + static void + parse (std::vector<X>& c, bool& xs, scanner& s) + { + X x; + bool dummy; + parser<X>::parse (x, dummy, s); + c.push_back (x); + xs = true; + } + }; + + template <typename X, typename C> + struct parser<std::set<X, C> > + { + static void + parse (std::set<X, C>& c, bool& xs, scanner& s) + { + X x; + bool dummy; + parser<X>::parse (x, dummy, s); + c.insert (x); + xs = true; + } + }; + + template <typename K, typename V, typename C> + struct parser<std::map<K, V, C> > + { + static void + parse (std::map<K, V, C>& m, bool& xs, scanner& s) + { + const char* o (s.next ()); + + if (s.more ()) + { + std::size_t pos (s.position ()); + std::string ov (s.next ()); + std::string::size_type p = ov.find ('='); + + K k = K (); + V v = V (); + std::string kstr (ov, 0, p); + std::string vstr (ov, (p != std::string::npos ? p + 1 : ov.size ())); + + int ac (2); + char* av[] = + { + const_cast<char*> (o), + 0 + }; + + bool dummy; + if (!kstr.empty ()) + { + av[1] = const_cast<char*> (kstr.c_str ()); + argv_scanner s (0, ac, av, false, pos); + parser<K>::parse (k, dummy, s); + } + + if (!vstr.empty ()) + { + av[1] = const_cast<char*> (vstr.c_str ()); + argv_scanner s (0, ac, av, false, pos); + parser<V>::parse (v, dummy, s); + } + + m[k] = v; + } + else + throw missing_value (o); + + xs = true; + } + }; + + template <typename K, typename V, typename C> + struct parser<std::multimap<K, V, C> > + { + static void + parse (std::multimap<K, V, C>& m, bool& xs, scanner& s) + { + const char* o (s.next ()); + + if (s.more ()) + { + std::size_t pos (s.position ()); + std::string ov (s.next ()); + std::string::size_type p = ov.find ('='); + + K k = K (); + V v = V (); + std::string kstr (ov, 0, p); + std::string vstr (ov, (p != std::string::npos ? p + 1 : ov.size ())); + + int ac (2); + char* av[] = + { + const_cast<char*> (o), + 0 + }; + + bool dummy; + if (!kstr.empty ()) + { + av[1] = const_cast<char*> (kstr.c_str ()); + argv_scanner s (0, ac, av, false, pos); + parser<K>::parse (k, dummy, s); + } + + if (!vstr.empty ()) + { + av[1] = const_cast<char*> (vstr.c_str ()); + argv_scanner s (0, ac, av, false, pos); + parser<V>::parse (v, dummy, s); + } + + m.insert (typename std::multimap<K, V, C>::value_type (k, v)); + } + else + throw missing_value (o); + + xs = true; + } + }; + + template <typename X, typename T, T X::*M> + void + thunk (X& x, scanner& s) + { + parser<T>::parse (x.*M, s); + } + + template <typename X, bool X::*M> + void + thunk (X& x, scanner& s) + { + s.next (); + x.*M = true; + } + + template <typename X, typename T, T X::*M, bool X::*S> + void + thunk (X& x, scanner& s) + { + parser<T>::parse (x.*M, x.*S, s); + } + } +} + +#include <map> + +namespace openssl +{ + namespace client + { + // options + // + + options:: + options () + : help_ (), + version_ (), + sign_ (), + keyform_ (), + keyform_specified_ (false), + engine_ (), + engine_specified_ (false), + inkey_ (), + inkey_specified_ (false), + simulate_ (), + simulate_specified_ (false) + { + } + + bool options:: + parse (int& argc, + char** argv, + bool erase, + ::openssl::cli::unknown_mode opt, + ::openssl::cli::unknown_mode arg) + { + ::openssl::cli::argv_scanner s (argc, argv, erase); + bool r = _parse (s, opt, arg); + return r; + } + + bool options:: + parse (int start, + int& argc, + char** argv, + bool erase, + ::openssl::cli::unknown_mode opt, + ::openssl::cli::unknown_mode arg) + { + ::openssl::cli::argv_scanner s (start, argc, argv, erase); + bool r = _parse (s, opt, arg); + return r; + } + + bool options:: + parse (int& argc, + char** argv, + int& end, + bool erase, + ::openssl::cli::unknown_mode opt, + ::openssl::cli::unknown_mode arg) + { + ::openssl::cli::argv_scanner s (argc, argv, erase); + bool r = _parse (s, opt, arg); + end = s.end (); + return r; + } + + bool options:: + parse (int start, + int& argc, + char** argv, + int& end, + bool erase, + ::openssl::cli::unknown_mode opt, + ::openssl::cli::unknown_mode arg) + { + ::openssl::cli::argv_scanner s (start, argc, argv, erase); + bool r = _parse (s, opt, arg); + end = s.end (); + return r; + } + + bool options:: + parse (::openssl::cli::scanner& s, + ::openssl::cli::unknown_mode opt, + ::openssl::cli::unknown_mode arg) + { + bool r = _parse (s, opt, arg); + return r; + } + + ::openssl::cli::usage_para options:: + print_usage (::std::ostream& os, ::openssl::cli::usage_para p) + { + CLI_POTENTIALLY_UNUSED (os); + + if (p != ::openssl::cli::usage_para::none) + os << ::std::endl; + + os << "\033[1mOPTIONS\033[0m" << ::std::endl; + + os << std::endl + << "\033[1m--help\033[0m Print usage information and exit." << ::std::endl; + + os << std::endl + << "\033[1m--version\033[0m Print version and exit." << ::std::endl; + + os << std::endl + << "\033[1m-sign\033[0m Sign data read from \033[1mstdin\033[0m." << ::std::endl; + + os << std::endl + << "\033[1m-keyform\033[0m \033[4mform\033[0m Private key format. The only supported format is \033[1mengine\033[0m." << ::std::endl; + + os << std::endl + << "\033[1m-engine\033[0m \033[4mengine\033[0m Engine to use for the cryptographic operation. The only" << ::std::endl + << " supported engine is \033[1mpkcs11\033[0m." << ::std::endl; + + os << std::endl + << "\033[1m-inkey\033[0m \033[4mlocation\033[0m Private key location. Its format (file path, URL, etc)" << ::std::endl + << " depends on the engine used. For the \033[1mpkcs11\033[0m engine it" << ::std::endl + << " should be a \033[1mPKCS#11\033[0m URL." << ::std::endl; + + os << std::endl + << "\033[1m--simulate\033[0m \033[4moutcome\033[0m Ask the agent to simulate the cryptographic operation" << ::std::endl + << " instead of performing it for real." << ::std::endl; + + p = ::openssl::cli::usage_para::option; + + return p; + } + + typedef + std::map<std::string, void (*) (options&, ::openssl::cli::scanner&)> + _cli_options_map; + + static _cli_options_map _cli_options_map_; + + struct _cli_options_map_init + { + _cli_options_map_init () + { + _cli_options_map_["--help"] = + &::openssl::cli::thunk< options, &options::help_ >; + _cli_options_map_["--version"] = + &::openssl::cli::thunk< options, &options::version_ >; + _cli_options_map_["-sign"] = + &::openssl::cli::thunk< options, &options::sign_ >; + _cli_options_map_["-keyform"] = + &::openssl::cli::thunk< options, string, &options::keyform_, + &options::keyform_specified_ >; + _cli_options_map_["-engine"] = + &::openssl::cli::thunk< options, string, &options::engine_, + &options::engine_specified_ >; + _cli_options_map_["-inkey"] = + &::openssl::cli::thunk< options, string, &options::inkey_, + &options::inkey_specified_ >; + _cli_options_map_["--simulate"] = + &::openssl::cli::thunk< options, simulate_outcome, &options::simulate_, + &options::simulate_specified_ >; + } + }; + + static _cli_options_map_init _cli_options_map_init_; + + bool options:: + _parse (const char* o, ::openssl::cli::scanner& s) + { + _cli_options_map::const_iterator i (_cli_options_map_.find (o)); + + if (i != _cli_options_map_.end ()) + { + (*(i->second)) (*this, s); + return true; + } + + return false; + } + + bool options:: + _parse (::openssl::cli::scanner& s, + ::openssl::cli::unknown_mode opt_mode, + ::openssl::cli::unknown_mode arg_mode) + { + // Can't skip combined flags (--no-combined-flags). + // + assert (opt_mode != ::openssl::cli::unknown_mode::skip); + + bool r = false; + bool opt = true; + + while (s.more ()) + { + const char* o = s.peek (); + + if (std::strcmp (o, "--") == 0) + { + opt = false; + s.skip (); + r = true; + continue; + } + + if (opt) + { + if (_parse (o, s)) + { + r = true; + continue; + } + + if (std::strncmp (o, "-", 1) == 0 && o[1] != '\0') + { + // Handle combined option values. + // + std::string co; + if (const char* v = std::strchr (o, '=')) + { + co.assign (o, 0, v - o); + ++v; + + int ac (2); + char* av[] = + { + const_cast<char*> (co.c_str ()), + const_cast<char*> (v) + }; + + ::openssl::cli::argv_scanner ns (0, ac, av); + + if (_parse (co.c_str (), ns)) + { + // Parsed the option but not its value? + // + if (ns.end () != 2) + throw ::openssl::cli::invalid_value (co, v); + + s.next (); + r = true; + continue; + } + else + { + // Set the unknown option and fall through. + // + o = co.c_str (); + } + } + + // Handle combined flags. + // + char cf[3]; + { + const char* p = o + 1; + for (; *p != '\0'; ++p) + { + if (!((*p >= 'a' && *p <= 'z') || + (*p >= 'A' && *p <= 'Z') || + (*p >= '0' && *p <= '9'))) + break; + } + + if (*p == '\0') + { + for (p = o + 1; *p != '\0'; ++p) + { + std::strcpy (cf, "-"); + cf[1] = *p; + cf[2] = '\0'; + + int ac (1); + char* av[] = + { + cf + }; + + ::openssl::cli::argv_scanner ns (0, ac, av); + + if (!_parse (cf, ns)) + break; + } + + if (*p == '\0') + { + // All handled. + // + s.next (); + r = true; + continue; + } + else + { + // Set the unknown option and fall through. + // + o = cf; + } + } + } + + switch (opt_mode) + { + case ::openssl::cli::unknown_mode::skip: + { + s.skip (); + r = true; + continue; + } + case ::openssl::cli::unknown_mode::stop: + { + break; + } + case ::openssl::cli::unknown_mode::fail: + { + throw ::openssl::cli::unknown_option (o); + } + } + + break; + } + } + + switch (arg_mode) + { + case ::openssl::cli::unknown_mode::skip: + { + s.skip (); + r = true; + continue; + } + case ::openssl::cli::unknown_mode::stop: + { + break; + } + case ::openssl::cli::unknown_mode::fail: + { + throw ::openssl::cli::unknown_argument (o); + } + } + + break; + } + + return r; + } + } +} + +namespace openssl +{ + ::openssl::cli::usage_para + print_openssl_client_usage (::std::ostream& os, ::openssl::cli::usage_para p) + { + CLI_POTENTIALLY_UNUSED (os); + + if (p != ::openssl::cli::usage_para::none) + os << ::std::endl; + + os << "\033[1mSYNOPSIS\033[0m" << ::std::endl + << ::std::endl + << "\033[1mopenssl-client --help\033[0m" << ::std::endl + << "\033[1mopenssl-client --version\033[0m" << ::std::endl + << "\033[1mopenssl-client\033[0m pkeyutl [\033[4moptions\033[0m]\033[0m" << ::std::endl + << ::std::endl + << "\033[1mDESCRIPTION\033[0m" << ::std::endl + << ::std::endl + << "The \033[1mpkeyutl\033[0m command is a drop-in replacement for the \033[1mopenssl-pkeyutl(1)\033[0m" << ::std::endl + << "cryptographic operations. Instead of performing the operations itself, it" << ::std::endl + << "forwards the request to an OpenSSL key agent that keeps the private key" << ::std::endl + << "unlocked for the session." << ::std::endl + << ::std::endl + << "Currently, data signing with a private key stored in a \033[1mPKCS#11\033[0m token is the" << ::std::endl + << "only supported arrangement. This limits the \033[1mopenssl-pkeyutl(1)\033[0m options and" << ::std::endl + << "values to the following usage:" << ::std::endl + << ::std::endl + << "$ openssl-client pkeyutl -sign -keyform engine -engine pkcs11 -inkey pkcs11:..." << ::std::endl + << ::std::endl + << "This command reads data from \033[1mstdin\033[0m, asks \033[1mopenssl-agent-pkcs11(1)\033[0m to sign it" << ::std::endl + << "using the specified unlocked private key, and prints the resulting signature to" << ::std::endl + << "\033[1mstdout\033[0m." << ::std::endl + << ::std::endl + << "Note that the \033[1mrsautl\033[0m command is also accepted for backwards compatibility." << ::std::endl + << ::std::endl + << "The command can be simulated without actually performing any cryptographic" << ::std::endl + << "operations. If the \033[1m--simulate\033[0m option is specified with the \033[1msuccess\033[0m outcome," << ::std::endl + << "then the command prints a dummy signature produced by the agent and exits with" << ::std::endl + << "zero status. The \033[1mfailure\033[0m outcome causes it to print the diagnostics to \033[1mstderr\033[0m" << ::std::endl + << "and exit with non-zero status. This mode is mostly useful for OpenSSL key" << ::std::endl + << "agents testing." << ::std::endl; + + p = ::openssl::client::options::print_usage (os, ::openssl::cli::usage_para::text); + + if (p != ::openssl::cli::usage_para::none) + os << ::std::endl; + + os << "\033[1mENVIRONMENT\033[0m" << ::std::endl + << ::std::endl + << "If \033[1m-engine\033[0m is \033[1mpkcs11\033[0m, then the \033[1mOPENSSL_AGENT_PKCS11_SOCK\033[0m environment variable" << ::std::endl + << "should be set to the Unix-domain socket of the \033[1mopenssl-agent-pkcs11(1)\033[0m daemon." << ::std::endl; + + os << std::endl + << "\033[1mEXIT STATUS\033[0m" << ::std::endl + << ::std::endl + << "Non-zero exit status is returned in case of an error." << ::std::endl; + + p = ::openssl::cli::usage_para::text; + + return p; + } +} + +// Begin epilogue. +// +// +// End epilogue. + diff --git a/openssl/client/options.hxx b/openssl/client/options.hxx new file mode 100644 index 0000000..5b61682 --- /dev/null +++ b/openssl/client/options.hxx @@ -0,0 +1,150 @@ +// -*- C++ -*- +// +// This file was generated by CLI, a command line interface +// compiler for C++. +// + +#ifndef OPENSSL_CLIENT_OPTIONS_HXX +#define OPENSSL_CLIENT_OPTIONS_HXX + +// Begin prologue. +// +// +// End prologue. + +#include <openssl/options.hxx> + +namespace openssl +{ + namespace client + { + class options + { + public: + options (); + + // Return true if anything has been parsed. + // + bool + parse (int& argc, + char** argv, + bool erase = false, + ::openssl::cli::unknown_mode option = ::openssl::cli::unknown_mode::fail, + ::openssl::cli::unknown_mode argument = ::openssl::cli::unknown_mode::stop); + + bool + parse (int start, + int& argc, + char** argv, + bool erase = false, + ::openssl::cli::unknown_mode option = ::openssl::cli::unknown_mode::fail, + ::openssl::cli::unknown_mode argument = ::openssl::cli::unknown_mode::stop); + + bool + parse (int& argc, + char** argv, + int& end, + bool erase = false, + ::openssl::cli::unknown_mode option = ::openssl::cli::unknown_mode::fail, + ::openssl::cli::unknown_mode argument = ::openssl::cli::unknown_mode::stop); + + bool + parse (int start, + int& argc, + char** argv, + int& end, + bool erase = false, + ::openssl::cli::unknown_mode option = ::openssl::cli::unknown_mode::fail, + ::openssl::cli::unknown_mode argument = ::openssl::cli::unknown_mode::stop); + + bool + parse (::openssl::cli::scanner&, + ::openssl::cli::unknown_mode option = ::openssl::cli::unknown_mode::fail, + ::openssl::cli::unknown_mode argument = ::openssl::cli::unknown_mode::stop); + + // Option accessors. + // + const bool& + help () const; + + const bool& + version () const; + + const bool& + sign () const; + + const string& + keyform () const; + + bool + keyform_specified () const; + + const string& + engine () const; + + bool + engine_specified () const; + + const string& + inkey () const; + + bool + inkey_specified () const; + + const simulate_outcome& + simulate () const; + + bool + simulate_specified () const; + + // Print usage information. + // + static ::openssl::cli::usage_para + print_usage (::std::ostream&, + ::openssl::cli::usage_para = ::openssl::cli::usage_para::none); + + // Implementation details. + // + protected: + bool + _parse (const char*, ::openssl::cli::scanner&); + + private: + bool + _parse (::openssl::cli::scanner&, + ::openssl::cli::unknown_mode option, + ::openssl::cli::unknown_mode argument); + + public: + bool help_; + bool version_; + bool sign_; + string keyform_; + bool keyform_specified_; + string engine_; + bool engine_specified_; + string inkey_; + bool inkey_specified_; + simulate_outcome simulate_; + bool simulate_specified_; + }; + } +} + +// Print page usage information. +// +namespace openssl +{ + ::openssl::cli::usage_para + print_openssl_client_usage (::std::ostream&, + ::openssl::cli::usage_para = ::openssl::cli::usage_para::none); +} + +#include <openssl/client/options.ixx> + +// Begin epilogue. +// +// +// End epilogue. + +#endif // OPENSSL_CLIENT_OPTIONS_HXX diff --git a/openssl/client/options.ixx b/openssl/client/options.ixx new file mode 100644 index 0000000..2ecad17 --- /dev/null +++ b/openssl/client/options.ixx @@ -0,0 +1,90 @@ +// -*- C++ -*- +// +// This file was generated by CLI, a command line interface +// compiler for C++. +// + +// Begin prologue. +// +// +// End prologue. + +namespace openssl +{ + namespace client + { + // options + // + + inline const bool& options:: + help () const + { + return this->help_; + } + + inline const bool& options:: + version () const + { + return this->version_; + } + + inline const bool& options:: + sign () const + { + return this->sign_; + } + + inline const string& options:: + keyform () const + { + return this->keyform_; + } + + inline bool options:: + keyform_specified () const + { + return this->keyform_specified_; + } + + inline const string& options:: + engine () const + { + return this->engine_; + } + + inline bool options:: + engine_specified () const + { + return this->engine_specified_; + } + + inline const string& options:: + inkey () const + { + return this->inkey_; + } + + inline bool options:: + inkey_specified () const + { + return this->inkey_specified_; + } + + inline const simulate_outcome& options:: + simulate () const + { + return this->simulate_; + } + + inline bool options:: + simulate_specified () const + { + return this->simulate_specified_; + } + } +} + +// Begin epilogue. +// +// +// End epilogue. |