current nightly

Sortix 1.1dev nightly manual

This manual documents Sortix 1.1dev nightly, a development build that has not been officially released. You can instead view this document in the latest official manual.

SSL_CTX_SET_DEFAULT_PASSWD_CB(3)

Library Functions Manual

SSL_CTX_SET_DEFAULT_PASSWD_CB(3)

NAME

SSL_CTX_set_default_passwd_cb, SSL_CTX_set_default_passwd_cb_userdata, SSL_CTX_get_default_passwd_cb, SSL_CTX_get_default_passwd_cb_userdata, pem_password_cb —

set or get passwd callback for encrypted PEM file handling

SYNOPSIS

#include
  <openssl/ssl.h>

void
SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, pem_password_cb *cb);

void
SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx, void *u);

pem_password_cb *
SSL_CTX_get_default_passwd_cb(SSL_CTX *ctx);

void *
SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX *ctx);

#include
  <openssl/pem.h>

typedef int
pem_password_cb(char *buf, int size, int rwflag, void *userdata);

DESCRIPTION

SSL_CTX_set_default_passwd_cb() sets the default password callback called when loading/storing a PEM certificate with encryption.

SSL_CTX_set_default_passwd_cb_userdata() sets a pointer to userdata u which will be provided to the password callback on invocation.

The password callback cb, which must be provided by the application, hands back the password to be used during decryption. On invocation a pointer to userdata is provided. The password callback must write the password into the provided buffer buf which is of size size. The actual length of the password must be returned to the calling function. rwflag indicates whether the callback is used for reading/decryption (rwflag = 0) or writing/encryption (rwflag = 1).

When loading or storing private keys, a password might be supplied to protect the private key. The way this password can be supplied may depend on the application. If only one private key is handled, it can be practical to have the callback handle the password dialog interactively. If several keys have to be handled, it can be practical to ask for the password once, then keep it in memory and use it several times. In the last case, the password could be stored into the userdata storage and the callback only returns the password already stored.

When asking for the password interactively, the callback can use rwflag to check whether an item shall be encrypted (rwflag = 1). In this case the password dialog may ask for the same password twice for comparison in order to catch typos which would make decryption impossible.

Other items in PEM formatting (certificates) can also be encrypted; it is however atypical, as certificate information is considered public.

RETURN VALUES

SSL_CTX_get_default_passwd_cb() returns a function pointer to the password callback currently set in ctx, or NULL if none is set.

SSL_CTX_get_default_passwd_cb_userdata() returns a pointer to the userdata currently set in ctx, or NULL if none is set.

EXAMPLES

The following example returns the password provided as userdata to the calling function. The password is considered to be a ‘\0’ terminated string. If the password does not fit into the buffer, the password is truncated.

int pem_passwd_cb(char *buf, int size, int rwflag, void *password) 
{ 
	strncpy(buf, (char *)password, size); 
	buf[size - 1] = '\0'; 
	return strlen(buf); 
}

HISTORY

SSL_CTX_set_default_passwd_cb() first appeared in SSLeay 0.6.2 and has been available since OpenBSD 2.4.

SSL_CTX_set_default_passwd_cb_userdata() first appeared in OpenSSL 0.9.4 and has been available since OpenBSD 2.6.

SSL_CTX_get_default_passwd_cb() and SSL_CTX_get_default_passwd_cb_userdata() first appeared in OpenSSL 1.1.0 and have been available since OpenBSD 6.3.

April 2, 2018

Debian