NAME

SSL_set_purpose − Set a purpose value to the SSL structure

SYNOPSIS

#include <openssl/ssl.h>
#include <openssl/x509v3.h>(to use the macros for purpose values) int SSL_set_purpose(
        SSL ∗s,
        int purpose );

DESCRIPTION

The SSL_set_purpose() function sets a purpose value in the SSL structure.  The purpose values and their macros are defined in x509v3.h as follows:

#define X509_PURPOSE_SSL_CLIENT 1
#define X509_PURPOSE_SSL_SERVER 2
#define X509_PURPOSE_NS_SSL_SERVER 3
#define X509_PURPOSE_SMIME_SIGN 4
#define X509_PURPOSE_SMIME_ENCRYPT 5
#define X509_PURPOSE_CRL_SIGN 6
#define X509_PURPOSE_ANY 7

The purpose value must be between 1 and 7.  If an out-of-range value is passed, SSL_set_purpose() returns 0.  Upon success, 1 is returned. 

RETURN VALUES

The following return values can occur:

1The purpose value was successfully set in the SSL structure. 

0Setting the purpose value in the SSL structure failed. 

SEE ALSO

Functions: SSL_CTX_set_purpose(3)