ssl_engine_pphrase.c revision 93556ea2f00ffd80b2c81831715dbaf545f840a2
/* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/* _ _
* _ __ ___ ___ __| | ___ ___| | mod_ssl
* | '_ ` _ \ / _ \ / _` | / __/ __| | Apache Interface to OpenSSL
* | | | | | | (_) | (_| | \__ \__ \ |
* |_| |_| |_|\___/ \__,_|___|___/___/_|
* |_____|
* Pass Phrase Dialog
*/
/* ``Treat your password like your
toothbrush. Don't let anybody
else use it, and get a new one
every six months.''
-- Clifford Stoll */
#include "ssl_private.h"
typedef struct {
server_rec *s;
apr_pool_t *p;
int nPassPhraseCur;
char *cpPassPhraseCur;
int nPassPhraseDialog;
int nPassPhraseDialogCur;
const char *key_id;
const char *pkey_file;
/*
* Return true if the named file exists and is readable
*/
{
apr_file_t *fd;
return stat;
return APR_EGENERAL;
return stat;
if (mtime) {
}
return APR_SUCCESS;
}
/*
* reuse vhost keys for asn1 tables where keys are allocated out
* of s->process->pool to prevent "leaking" each time we format
* a vhost key. since the key is stored in a table with lifetime
* of s->process->pool, the key needs to have the same lifetime.
*
* XXX: probably seems silly to use a hash table with keys and values
* being the same, but it is easier than doing a linear search
* and will make it easier to remove keys if needed in the future.
* also have the problem with apr_array_header_t that if we
* underestimate the number of vhost keys when we apr_array_make(),
* the array will get resized when we push past the initial number
* of elts. this resizing in the s->process->pool means "leaking"
* since apr_array_push() will apr_alloc arr->nalloc * 2 elts,
* leaving the original arr->elts to waste.
*/
const char *id, int i)
{
/* 'p' pool used here is cleared on restarts (or sooner) */
if (!keyptr) {
/* make a copy out of s->process->pool */
}
return (char *)keyptr;
}
/* _________________________________________________________________
**
** Pass Phrase and Private Key Handling
** _________________________________________________________________
*/
#define BUILTIN_DIALOG_BACKOFF 2
#define BUILTIN_DIALOG_RETRIES 5
int ssl_pphrase_Handle_CB(char *, int, int, void *);
{
return NULL;
}
}
const char *pkey_file,
{
unsigned char *ucp;
long int length;
int nPassPhraseRetry = 0;
apr_time_t pkey_mtime = 0;
if (!pkey_file) {
"Init: No private key specified for %s", key_id);
return ssl_die(s);
}
!= APR_SUCCESS ) {
"Init: Can't open server private key file %s", pkey_file);
return ssl_die(s);
}
ppcb_arg.s = s;
ppcb_arg.p = p;
ppcb_arg.nPassPhraseCur = 0;
/*
* if the private key is encrypted and SSLPassPhraseDialog
* is configured to "builtin" it isn't possible to prompt for
* a password after httpd has detached from the tty.
* in this case if we already have a private key and the
* we also reuse existing private keys that were encrypted for
* exec: and pipe: dialogs to minimize chances to snoop the
* password. that and pipe: dialogs might prompt the user
* for password, which on win32 for example could happen 4
* times at startup. twice for each child and twice within
* each since apache "restarts itself" on startup.
* of course this will not work for the builtin dialog if
* the server was started without LoadModule ssl_module
* configured, then restarted with it configured.
* but we fall through with a chance of success if the key
* is not encrypted or can be handled via exec or pipe dialog.
* and in the case of fallthrough, pkey_mtime and isatty()
* are used to give a better idea as to what failed.
*/
if (pkey_mtime) {
"Reusing existing private key from %s on restart",
return APR_SUCCESS;
}
}
"Attempting to load encrypted (?) private key %s", key_id);
for (;;) {
/*
* Try to read the private key file with the help of
* the callback function which serves the pass
* phrases to OpenSSL
*/
/* Ensure that the error stack is empty; some SSL
* functions will fail spuriously if the error stack
* is not empty. */
/*
* when the private key file now was readable,
* it's fine and we go out of the loop
*/
if (bReadable)
break;
/*
* when we have more remembered pass phrases
* try to reuse these first.
*/
continue;
}
/*
* else it's not readable and we have no more
* remembered pass phrases. Then this has to mean
* that the callback function popped up the dialog
* but a wrong pass phrase was entered. We give the
* user (but not the dialog program) a few more
* chances...
*/
#ifndef WIN32
#else
#endif
&& nPassPhraseRetry < BUILTIN_DIALOG_RETRIES ) {
"(%d more retr%s permitted).\n",
* 5 * APR_USEC_PER_SEC);
continue;
}
#ifdef WIN32
"Init: SSLPassPhraseDialog builtin is not "
"supported on Win32 (key file "
return ssl_die(s);
}
#endif /* WIN32 */
/*
* Ok, anything else now means a fatal error.
*/
{
s, APLOGNO(02578)
"Init: Unable to read pass phrase "
"[Hint: key introduced or changed "
"before restart?]");
}
else {
}
if (writetty) {
}
}
else {
"Init: Pass phrase incorrect for key %s",
key_id);
if (writetty) {
}
}
return ssl_die(s);
}
if (pPrivateKey == NULL) {
"Init: Unable to read server private key from file %s",
return ssl_die(s);
}
/*
* Log the type of reading
*/
if (ppcb_arg.nPassPhraseDialogCur == 0) {
"unencrypted %s private key - pass phrase not "
"required", key_id);
}
else {
s, APLOGNO(02583)
"encrypted %s private key - pass phrase "
"requested", key_id);
}
else {
s, APLOGNO(02584)
"encrypted %s private key - pass phrase"
" reused", key_id);
}
}
/*
* Ok, when we have one more pass phrase store it
*/
nPassPhrase++;
}
/*
* Insert private key into the global module configuration
* (we convert it to a stand-alone DER byte sequence
* because the SSL library uses static variables inside a
* RSA structure which do not survive DSO reloads!)
*/
if (ppcb_arg.nPassPhraseDialogCur != 0) {
/* remember mtime of encrypted keys */
}
/*
* Free the private key structure
*/
/*
* Let the user know when we're successful.
*/
if ((ppcb_arg.nPassPhraseDialog > 0) &&
if (writetty) {
"OK: Pass Phrase Dialog successful.\n");
}
}
/* Close the pipes if they were opened
*/
if (readtty) {
}
return APR_SUCCESS;
}
{
/* Child process code for 'ErrorLog "|..."';
* may want a common framework for this, since I expect it will
* be common for other foo-loggers to want this sort of thing...
*/
APR_NO_PIPE)) == APR_SUCCESS)) {
char **args;
if (rc == APR_SUCCESS) {
/* XXX: not sure if we aught to...
* apr_pool_note_subprocess(p, procnew, APR_KILL_AFTER_TIMEOUT);
*/
}
}
return rc;
}
{
char *p;
buf[0]='\0';
return 1; /* failure */
}
*p = '\0';
}
#ifdef WIN32
/* XXX: apr_sometest */
*p = '\0';
}
#endif
return 0;
}
{
char *cpp;
int len = -1;
/*
* When remembered pass phrases are available use them...
*/
return len;
}
/*
* Builtin or Pipe dialog
*/
char *prompt;
int i;
if (!readtty) {
APLOGNO(01965)
"Init: Creating pass phrase dialog pipe child "
if (ssl_pipe_child_create(ppcb_arg->p,
!= APR_SUCCESS) {
APLOGNO(01966)
"Init: Failed to create pass phrase pipe '%s'",
return (-1);
}
}
"Init: Requesting pass phrase via piped dialog");
}
else { /* sc->server->pphrase_dialog_type == SSL_PPTYPE_BUILTIN */
#ifdef WIN32
return (-1);
#else
/*
* stderr has already been redirected to the error_log.
* rather than attempting to temporarily rehook it to the terminal,
* we print the prompt to stdout before EVP_read_pw_string turns
* off tty echo
*/
"Init: Requesting pass phrase via builtin terminal "
"dialog");
#endif
}
/*
* The first time display a header to inform the user about what
* program he actually speaks to, which module is responsible for
* this terminal dialog and why to the hell he has to enter
* something...
*/
}
if (ppcb_arg->bPassPhraseDialogOnce) {
}
/*
* Emulate the OpenSSL internal pass phrase dialog
*/
prompt = "Enter pass phrase:";
for (;;) {
}
else { /* sc->server->pphrase_dialog_type == SSL_PPTYPE_BUILTIN */
}
if (i != 0) {
return (-1);
}
if (len < 1)
apr_file_printf(writetty, "Apache:mod_ssl:Error: Pass phrase empty (needs to be at least 1 character).\n");
else
break;
}
}
/*
* Filter program
*/
char *result;
"Init: Requesting pass phrase from dialog filter "
"program (%s)", cmd);
}
/*
* Ok, we now have the pass phrase, so give it back
*/
/*
* And return its length to OpenSSL...
*/
return (len);
}