mirror of
https://gitlab.winehq.org/wine/wine-gecko.git
synced 2024-09-13 09:24:08 -07:00
0ccf958b45
== NSS portion == r=rrelyea/wtc for upgrading mozilla-central to cvs tag NSS_3_12_6_BETA1 == This includes reapplying the (merged) patch from bug 519550 on top of NSS. == PSM portion == Includes the patch to disable TLS compression, r=kaie == Include the patch to disable zlib test programs, which don't work on maemo, r=kaie
617 lines
26 KiB
C
617 lines
26 KiB
C
/*
|
|
* This file contains prototypes for the public SSL functions.
|
|
*
|
|
* ***** BEGIN LICENSE BLOCK *****
|
|
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
|
*
|
|
* The contents of this file are subject to the Mozilla Public License Version
|
|
* 1.1 (the "License"); you may not use this file except in compliance with
|
|
* the License. You may obtain a copy of the License at
|
|
* http://www.mozilla.org/MPL/
|
|
*
|
|
* Software distributed under the License is distributed on an "AS IS" basis,
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
|
* for the specific language governing rights and limitations under the
|
|
* License.
|
|
*
|
|
* The Original Code is the Netscape security libraries.
|
|
*
|
|
* The Initial Developer of the Original Code is
|
|
* Netscape Communications Corporation.
|
|
* Portions created by the Initial Developer are Copyright (C) 1994-2000
|
|
* the Initial Developer. All Rights Reserved.
|
|
*
|
|
* Contributor(s):
|
|
*
|
|
* Alternatively, the contents of this file may be used under the terms of
|
|
* either the GNU General Public License Version 2 or later (the "GPL"), or
|
|
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|
* in which case the provisions of the GPL or the LGPL are applicable instead
|
|
* of those above. If you wish to allow use of your version of this file only
|
|
* under the terms of either the GPL or the LGPL, and not to allow others to
|
|
* use your version of this file under the terms of the MPL, indicate your
|
|
* decision by deleting the provisions above and replace them with the notice
|
|
* and other provisions required by the GPL or the LGPL. If you do not delete
|
|
* the provisions above, a recipient may use your version of this file under
|
|
* the terms of any one of the MPL, the GPL or the LGPL.
|
|
*
|
|
* ***** END LICENSE BLOCK ***** */
|
|
/* $Id: ssl.h,v 1.35 2010/02/04 03:21:11 wtc%google.com Exp $ */
|
|
|
|
#ifndef __ssl_h_
|
|
#define __ssl_h_
|
|
|
|
#include "prtypes.h"
|
|
#include "prerror.h"
|
|
#include "prio.h"
|
|
#include "seccomon.h"
|
|
#include "cert.h"
|
|
#include "keyt.h"
|
|
|
|
#include "sslt.h" /* public ssl data types */
|
|
|
|
#if defined(_WIN32) && !defined(IN_LIBSSL) && !defined(NSS_USE_STATIC_LIBS)
|
|
#define SSL_IMPORT extern __declspec(dllimport)
|
|
#else
|
|
#define SSL_IMPORT extern
|
|
#endif
|
|
|
|
SEC_BEGIN_PROTOS
|
|
|
|
/* constant table enumerating all implemented SSL 2 and 3 cipher suites. */
|
|
SSL_IMPORT const PRUint16 SSL_ImplementedCiphers[];
|
|
|
|
/* number of entries in the above table. */
|
|
SSL_IMPORT const PRUint16 SSL_NumImplementedCiphers;
|
|
|
|
/* Macro to tell which ciphers in table are SSL2 vs SSL3/TLS. */
|
|
#define SSL_IS_SSL2_CIPHER(which) (((which) & 0xfff0) == 0xff00)
|
|
|
|
/*
|
|
** Imports fd into SSL, returning a new socket. Copies SSL configuration
|
|
** from model.
|
|
*/
|
|
SSL_IMPORT PRFileDesc *SSL_ImportFD(PRFileDesc *model, PRFileDesc *fd);
|
|
|
|
/*
|
|
** Enable/disable an ssl mode
|
|
**
|
|
** SSL_SECURITY:
|
|
** enable/disable use of SSL security protocol before connect
|
|
**
|
|
** SSL_SOCKS:
|
|
** enable/disable use of socks before connect
|
|
** (No longer supported).
|
|
**
|
|
** SSL_REQUEST_CERTIFICATE:
|
|
** require a certificate during secure connect
|
|
*/
|
|
/* options */
|
|
#define SSL_SECURITY 1 /* (on by default) */
|
|
#define SSL_SOCKS 2 /* (off by default) */
|
|
#define SSL_REQUEST_CERTIFICATE 3 /* (off by default) */
|
|
#define SSL_HANDSHAKE_AS_CLIENT 5 /* force accept to hs as client */
|
|
/* (off by default) */
|
|
#define SSL_HANDSHAKE_AS_SERVER 6 /* force connect to hs as server */
|
|
/* (off by default) */
|
|
#define SSL_ENABLE_SSL2 7 /* enable ssl v2 (on by default) */
|
|
#define SSL_ENABLE_SSL3 8 /* enable ssl v3 (on by default) */
|
|
#define SSL_NO_CACHE 9 /* don't use the session cache */
|
|
/* (off by default) */
|
|
#define SSL_REQUIRE_CERTIFICATE 10 /* (SSL_REQUIRE_FIRST_HANDSHAKE */
|
|
/* by default) */
|
|
#define SSL_ENABLE_FDX 11 /* permit simultaneous read/write */
|
|
/* (off by default) */
|
|
#define SSL_V2_COMPATIBLE_HELLO 12 /* send v3 client hello in v2 fmt */
|
|
/* (on by default) */
|
|
#define SSL_ENABLE_TLS 13 /* enable TLS (on by default) */
|
|
#define SSL_ROLLBACK_DETECTION 14 /* for compatibility, default: on */
|
|
#define SSL_NO_STEP_DOWN 15 /* Disable export cipher suites */
|
|
/* if step-down keys are needed. */
|
|
/* default: off, generate */
|
|
/* step-down keys if needed. */
|
|
#define SSL_BYPASS_PKCS11 16 /* use PKCS#11 for pub key only */
|
|
#define SSL_NO_LOCKS 17 /* Don't use locks for protection */
|
|
#define SSL_ENABLE_SESSION_TICKETS 18 /* Enable TLS SessionTicket */
|
|
/* extension (off by default) */
|
|
#define SSL_ENABLE_DEFLATE 19 /* Enable TLS compression with */
|
|
/* DEFLATE (off by default) */
|
|
#define SSL_ENABLE_RENEGOTIATION 20 /* Values below (default: never) */
|
|
#define SSL_REQUIRE_SAFE_NEGOTIATION 21 /* Peer must send Signalling */
|
|
/* Cipher Suite Value (SCSV) or */
|
|
/* Renegotiation Info (RI) */
|
|
/* extension in ALL handshakes. */
|
|
/* default: off */
|
|
|
|
#ifdef SSL_DEPRECATED_FUNCTION
|
|
/* Old deprecated function names */
|
|
SSL_IMPORT SECStatus SSL_Enable(PRFileDesc *fd, int option, PRBool on);
|
|
SSL_IMPORT SECStatus SSL_EnableDefault(int option, PRBool on);
|
|
#endif
|
|
|
|
/* New function names */
|
|
SSL_IMPORT SECStatus SSL_OptionSet(PRFileDesc *fd, PRInt32 option, PRBool on);
|
|
SSL_IMPORT SECStatus SSL_OptionGet(PRFileDesc *fd, PRInt32 option, PRBool *on);
|
|
SSL_IMPORT SECStatus SSL_OptionSetDefault(PRInt32 option, PRBool on);
|
|
SSL_IMPORT SECStatus SSL_OptionGetDefault(PRInt32 option, PRBool *on);
|
|
SSL_IMPORT SECStatus SSL_CertDBHandleSet(PRFileDesc *fd, CERTCertDBHandle *dbHandle);
|
|
|
|
/*
|
|
** Control ciphers that SSL uses. If on is non-zero then the named cipher
|
|
** is enabled, otherwise it is disabled.
|
|
** The "cipher" values are defined in sslproto.h (the SSL_EN_* values).
|
|
** EnableCipher records user preferences.
|
|
** SetPolicy sets the policy according to the policy module.
|
|
*/
|
|
#ifdef SSL_DEPRECATED_FUNCTION
|
|
/* Old deprecated function names */
|
|
SSL_IMPORT SECStatus SSL_EnableCipher(long which, PRBool enabled);
|
|
SSL_IMPORT SECStatus SSL_SetPolicy(long which, int policy);
|
|
#endif
|
|
|
|
/* New function names */
|
|
SSL_IMPORT SECStatus SSL_CipherPrefSet(PRFileDesc *fd, PRInt32 cipher, PRBool enabled);
|
|
SSL_IMPORT SECStatus SSL_CipherPrefGet(PRFileDesc *fd, PRInt32 cipher, PRBool *enabled);
|
|
SSL_IMPORT SECStatus SSL_CipherPrefSetDefault(PRInt32 cipher, PRBool enabled);
|
|
SSL_IMPORT SECStatus SSL_CipherPrefGetDefault(PRInt32 cipher, PRBool *enabled);
|
|
SSL_IMPORT SECStatus SSL_CipherPolicySet(PRInt32 cipher, PRInt32 policy);
|
|
SSL_IMPORT SECStatus SSL_CipherPolicyGet(PRInt32 cipher, PRInt32 *policy);
|
|
|
|
/* Values for "policy" argument to SSL_PolicySet */
|
|
/* Values returned by SSL_CipherPolicyGet. */
|
|
#define SSL_NOT_ALLOWED 0 /* or invalid or unimplemented */
|
|
#define SSL_ALLOWED 1
|
|
#define SSL_RESTRICTED 2 /* only with "Step-Up" certs. */
|
|
|
|
/* Values for "on" with SSL_REQUIRE_CERTIFICATE. */
|
|
#define SSL_REQUIRE_NEVER ((PRBool)0)
|
|
#define SSL_REQUIRE_ALWAYS ((PRBool)1)
|
|
#define SSL_REQUIRE_FIRST_HANDSHAKE ((PRBool)2)
|
|
#define SSL_REQUIRE_NO_ERROR ((PRBool)3)
|
|
|
|
/* Values for "on" with SSL_ENABLE_RENEGOTIATION */
|
|
/* Never renegotiate at all. */
|
|
#define SSL_RENEGOTIATE_NEVER ((PRBool)0)
|
|
/* Renegotiate without restriction, whether or not the peer's client hello */
|
|
/* bears the renegotiation info extension. Vulnerable, as in the past. */
|
|
#define SSL_RENEGOTIATE_UNRESTRICTED ((PRBool)1)
|
|
/* Only renegotiate if the peer's hello bears the TLS renegotiation_info */
|
|
/* extension. This is safe renegotiation. */
|
|
#define SSL_RENEGOTIATE_REQUIRES_XTN ((PRBool)2)
|
|
/* Disallow all renegotiation in server sockets only, but allow clients */
|
|
/* to continue to renegotiate with vulnerable servers. */
|
|
#define SSL_RENEGOTIATE_CLIENT_ONLY ((PRBool)3)
|
|
|
|
/*
|
|
** Reset the handshake state for fd. This will make the complete SSL
|
|
** handshake protocol execute from the ground up on the next i/o
|
|
** operation.
|
|
*/
|
|
SSL_IMPORT SECStatus SSL_ResetHandshake(PRFileDesc *fd, PRBool asServer);
|
|
|
|
/*
|
|
** Force the handshake for fd to complete immediately. This blocks until
|
|
** the complete SSL handshake protocol is finished.
|
|
*/
|
|
SSL_IMPORT SECStatus SSL_ForceHandshake(PRFileDesc *fd);
|
|
|
|
/*
|
|
** Same as above, but with an I/O timeout.
|
|
*/
|
|
SSL_IMPORT SECStatus SSL_ForceHandshakeWithTimeout(PRFileDesc *fd,
|
|
PRIntervalTime timeout);
|
|
|
|
/*
|
|
** Query security status of socket. *on is set to one if security is
|
|
** enabled. *keySize will contain the stream key size used. *issuer will
|
|
** contain the RFC1485 verison of the name of the issuer of the
|
|
** certificate at the other end of the connection. For a client, this is
|
|
** the issuer of the server's certificate; for a server, this is the
|
|
** issuer of the client's certificate (if any). Subject is the subject of
|
|
** the other end's certificate. The pointers can be zero if the desired
|
|
** data is not needed. All strings returned by this function are owned
|
|
** by the caller, and need to be freed with PORT_Free.
|
|
*/
|
|
SSL_IMPORT SECStatus SSL_SecurityStatus(PRFileDesc *fd, int *on, char **cipher,
|
|
int *keySize, int *secretKeySize,
|
|
char **issuer, char **subject);
|
|
|
|
/* Values for "on" */
|
|
#define SSL_SECURITY_STATUS_NOOPT -1
|
|
#define SSL_SECURITY_STATUS_OFF 0
|
|
#define SSL_SECURITY_STATUS_ON_HIGH 1
|
|
#define SSL_SECURITY_STATUS_ON_LOW 2
|
|
#define SSL_SECURITY_STATUS_FORTEZZA 3 /* NO LONGER SUPPORTED */
|
|
|
|
/*
|
|
** Return the certificate for our SSL peer. If the client calls this
|
|
** it will always return the server's certificate. If the server calls
|
|
** this, it may return NULL if client authentication is not enabled or
|
|
** if the client had no certificate when asked.
|
|
** "fd" the socket "file" descriptor
|
|
*/
|
|
SSL_IMPORT CERTCertificate *SSL_PeerCertificate(PRFileDesc *fd);
|
|
|
|
/*
|
|
** Authenticate certificate hook. Called when a certificate comes in
|
|
** (because of SSL_REQUIRE_CERTIFICATE in SSL_Enable) to authenticate the
|
|
** certificate.
|
|
*/
|
|
typedef SECStatus (PR_CALLBACK *SSLAuthCertificate)(void *arg, PRFileDesc *fd,
|
|
PRBool checkSig,
|
|
PRBool isServer);
|
|
|
|
SSL_IMPORT SECStatus SSL_AuthCertificateHook(PRFileDesc *fd,
|
|
SSLAuthCertificate f,
|
|
void *arg);
|
|
|
|
/* An implementation of the certificate authentication hook */
|
|
SSL_IMPORT SECStatus SSL_AuthCertificate(void *arg, PRFileDesc *fd,
|
|
PRBool checkSig, PRBool isServer);
|
|
|
|
/*
|
|
* Prototype for SSL callback to get client auth data from the application.
|
|
* arg - application passed argument
|
|
* caNames - pointer to distinguished names of CAs that the server likes
|
|
* pRetCert - pointer to pointer to cert, for return of cert
|
|
* pRetKey - pointer to key pointer, for return of key
|
|
*/
|
|
typedef SECStatus (PR_CALLBACK *SSLGetClientAuthData)(void *arg,
|
|
PRFileDesc *fd,
|
|
CERTDistNames *caNames,
|
|
CERTCertificate **pRetCert,/*return */
|
|
SECKEYPrivateKey **pRetKey);/* return */
|
|
|
|
/*
|
|
* Set the client side callback for SSL to retrieve user's private key
|
|
* and certificate.
|
|
* fd - the file descriptor for the connection in question
|
|
* f - the application's callback that delivers the key and cert
|
|
* a - application specific data
|
|
*/
|
|
SSL_IMPORT SECStatus SSL_GetClientAuthDataHook(PRFileDesc *fd,
|
|
SSLGetClientAuthData f, void *a);
|
|
|
|
|
|
/*
|
|
** SNI extension processing callback function.
|
|
** It is called when SSL socket receives SNI extension in ClientHello message.
|
|
** Upon this callback invocation, application is responsible to reconfigure the
|
|
** socket with the data for a particular server name.
|
|
** There are three potential outcomes of this function invocation:
|
|
** * application does not recognize the name or the type and wants the
|
|
** "unrecognized_name" alert be sent to the client. In this case the callback
|
|
** function must return SSL_SNI_SEND_ALERT status.
|
|
** * application does not recognize the name, but wants to continue with
|
|
** the handshake using the current socket configuration. In this case,
|
|
** no socket reconfiguration is needed and the function should return
|
|
** SSL_SNI_CURRENT_CONFIG_IS_USED.
|
|
** * application recognizes the name and reconfigures the socket with
|
|
** appropriate certs, key, etc. There are many ways to reconfigure. NSS
|
|
** provides SSL_ReconfigFD function that can be used to update the socket
|
|
** data from model socket. To continue with the rest of the handshake, the
|
|
** implementation function should return an index of a name it has chosen.
|
|
** LibSSL will ignore any SNI extension received in a ClientHello message
|
|
** if application does not register a SSLSNISocketConfig callback.
|
|
** Each type field of SECItem indicates the name type.
|
|
** NOTE: currently RFC3546 defines only one name type: sni_host_name.
|
|
** Client is allowed to send only one name per known type. LibSSL will
|
|
** send an "unrecognized_name" alert if SNI extension name list contains more
|
|
** then one name of a type.
|
|
*/
|
|
typedef PRInt32 (PR_CALLBACK *SSLSNISocketConfig)(PRFileDesc *fd,
|
|
const SECItem *srvNameArr,
|
|
PRUint32 srvNameArrSize,
|
|
void *arg);
|
|
|
|
/*
|
|
** SSLSNISocketConfig should return an index within 0 and srvNameArrSize-1
|
|
** when it has reconfigured the socket fd to use certs and keys, etc
|
|
** for a specific name. There are two other allowed return values. One
|
|
** tells libSSL to use the default cert and key. The other tells libSSL
|
|
** to send the "unrecognized_name" alert. These values are:
|
|
**/
|
|
#define SSL_SNI_CURRENT_CONFIG_IS_USED -1
|
|
#define SSL_SNI_SEND_ALERT -2
|
|
|
|
/*
|
|
** Set application implemented SNISocketConfig callback.
|
|
*/
|
|
SSL_IMPORT SECStatus SSL_SNISocketConfigHook(PRFileDesc *fd,
|
|
SSLSNISocketConfig f,
|
|
void *arg);
|
|
|
|
/*
|
|
** Reconfigure fd SSL socket with model socket parameters. Sets
|
|
** server certs and keys, list of trust anchor, socket options
|
|
** and all SSL socket call backs and parameters.
|
|
*/
|
|
SSL_IMPORT PRFileDesc *SSL_ReconfigFD(PRFileDesc *model, PRFileDesc *fd);
|
|
|
|
/*
|
|
* Set the client side argument for SSL to retrieve PKCS #11 pin.
|
|
* fd - the file descriptor for the connection in question
|
|
* a - pkcs11 application specific data
|
|
*/
|
|
SSL_IMPORT SECStatus SSL_SetPKCS11PinArg(PRFileDesc *fd, void *a);
|
|
|
|
/*
|
|
** This is a callback for dealing with server certs that are not authenticated
|
|
** by the client. The client app can decide that it actually likes the
|
|
** cert by some external means and restart the connection.
|
|
*/
|
|
typedef SECStatus (PR_CALLBACK *SSLBadCertHandler)(void *arg, PRFileDesc *fd);
|
|
SSL_IMPORT SECStatus SSL_BadCertHook(PRFileDesc *fd, SSLBadCertHandler f,
|
|
void *arg);
|
|
|
|
/*
|
|
** Configure SSL socket for running a secure server. Needs the
|
|
** certificate for the server and the servers private key. The arguments
|
|
** are copied.
|
|
*/
|
|
SSL_IMPORT SECStatus SSL_ConfigSecureServer(
|
|
PRFileDesc *fd, CERTCertificate *cert,
|
|
SECKEYPrivateKey *key, SSLKEAType kea);
|
|
|
|
/*
|
|
** Configure a secure server's session-id cache. Define the maximum number
|
|
** of entries in the cache, the longevity of the entires, and the directory
|
|
** where the cache files will be placed. These values can be zero, and
|
|
** if so, the implementation will choose defaults.
|
|
** This version of the function is for use in applications that have only one
|
|
** process that uses the cache (even if that process has multiple threads).
|
|
*/
|
|
SSL_IMPORT SECStatus SSL_ConfigServerSessionIDCache(int maxCacheEntries,
|
|
PRUint32 timeout,
|
|
PRUint32 ssl3_timeout,
|
|
const char * directory);
|
|
|
|
/* Configure a secure server's session-id cache. Depends on value of
|
|
* enableMPCache, configures malti-proc or single proc cache. */
|
|
SSL_IMPORT SECStatus SSL_ConfigServerSessionIDCacheWithOpt(
|
|
PRUint32 timeout,
|
|
PRUint32 ssl3_timeout,
|
|
const char * directory,
|
|
int maxCacheEntries,
|
|
int maxCertCacheEntries,
|
|
int maxSrvNameCacheEntries,
|
|
PRBool enableMPCache);
|
|
|
|
/*
|
|
** Like SSL_ConfigServerSessionIDCache, with one important difference.
|
|
** If the application will run multiple processes (as opposed to, or in
|
|
** addition to multiple threads), then it must call this function, instead
|
|
** of calling SSL_ConfigServerSessionIDCache().
|
|
** This has nothing to do with the number of processORs, only processEs.
|
|
** This function sets up a Server Session ID (SID) cache that is safe for
|
|
** access by multiple processes on the same system.
|
|
*/
|
|
SSL_IMPORT SECStatus SSL_ConfigMPServerSIDCache(int maxCacheEntries,
|
|
PRUint32 timeout,
|
|
PRUint32 ssl3_timeout,
|
|
const char * directory);
|
|
|
|
/* Get and set the configured maximum number of mutexes used for the
|
|
** server's store of SSL sessions. This value is used by the server
|
|
** session ID cache initialization functions shown above. Note that on
|
|
** some platforms, these mutexes are actually implemented with POSIX
|
|
** semaphores, or with unnamed pipes. The default value varies by platform.
|
|
** An attempt to set a too-low maximum will return an error and the
|
|
** configured value will not be changed.
|
|
*/
|
|
SSL_IMPORT PRUint32 SSL_GetMaxServerCacheLocks(void);
|
|
SSL_IMPORT SECStatus SSL_SetMaxServerCacheLocks(PRUint32 maxLocks);
|
|
|
|
/* environment variable set by SSL_ConfigMPServerSIDCache, and queried by
|
|
* SSL_InheritMPServerSIDCache when envString is NULL.
|
|
*/
|
|
#define SSL_ENV_VAR_NAME "SSL_INHERITANCE"
|
|
|
|
/* called in child to inherit SID Cache variables.
|
|
* If envString is NULL, this function will use the value of the environment
|
|
* variable "SSL_INHERITANCE", otherwise the string value passed in will be
|
|
* used.
|
|
*/
|
|
SSL_IMPORT SECStatus SSL_InheritMPServerSIDCache(const char * envString);
|
|
|
|
/*
|
|
** Set the callback on a particular socket that gets called when we finish
|
|
** performing a handshake.
|
|
*/
|
|
typedef void (PR_CALLBACK *SSLHandshakeCallback)(PRFileDesc *fd,
|
|
void *client_data);
|
|
SSL_IMPORT SECStatus SSL_HandshakeCallback(PRFileDesc *fd,
|
|
SSLHandshakeCallback cb, void *client_data);
|
|
|
|
/*
|
|
** For the server, request a new handshake. For the client, begin a new
|
|
** handshake. If flushCache is non-zero, the SSL3 cache entry will be
|
|
** flushed first, ensuring that a full SSL handshake will be done.
|
|
** If flushCache is zero, and an SSL connection is established, it will
|
|
** do the much faster session restart handshake. This will change the
|
|
** session keys without doing another private key operation.
|
|
*/
|
|
SSL_IMPORT SECStatus SSL_ReHandshake(PRFileDesc *fd, PRBool flushCache);
|
|
|
|
/*
|
|
** Same as above, but with an I/O timeout.
|
|
*/
|
|
SSL_IMPORT SECStatus SSL_ReHandshakeWithTimeout(PRFileDesc *fd,
|
|
PRBool flushCache,
|
|
PRIntervalTime timeout);
|
|
|
|
|
|
#ifdef SSL_DEPRECATED_FUNCTION
|
|
/* deprecated!
|
|
** For the server, request a new handshake. For the client, begin a new
|
|
** handshake. Flushes SSL3 session cache entry first, ensuring that a
|
|
** full handshake will be done.
|
|
** This call is equivalent to SSL_ReHandshake(fd, PR_TRUE)
|
|
*/
|
|
SSL_IMPORT SECStatus SSL_RedoHandshake(PRFileDesc *fd);
|
|
#endif
|
|
|
|
/*
|
|
* Allow the application to pass a URL or hostname into the SSL library.
|
|
*/
|
|
SSL_IMPORT SECStatus SSL_SetURL(PRFileDesc *fd, const char *url);
|
|
|
|
/*
|
|
* Allow an application to define a set of trust anchors for peer
|
|
* cert validation.
|
|
*/
|
|
SSL_IMPORT SECStatus SSL_SetTrustAnchors(PRFileDesc *fd, CERTCertList *list);
|
|
|
|
/*
|
|
** Return the number of bytes that SSL has waiting in internal buffers.
|
|
** Return 0 if security is not enabled.
|
|
*/
|
|
SSL_IMPORT int SSL_DataPending(PRFileDesc *fd);
|
|
|
|
/*
|
|
** Invalidate the SSL session associated with fd.
|
|
*/
|
|
SSL_IMPORT SECStatus SSL_InvalidateSession(PRFileDesc *fd);
|
|
|
|
/*
|
|
** Return a SECItem containing the SSL session ID associated with the fd.
|
|
*/
|
|
SSL_IMPORT SECItem *SSL_GetSessionID(PRFileDesc *fd);
|
|
|
|
/*
|
|
** Clear out the client's SSL session cache, not the server's session cache.
|
|
*/
|
|
SSL_IMPORT void SSL_ClearSessionCache(void);
|
|
|
|
/*
|
|
** Close the server's SSL session cache.
|
|
*/
|
|
SSL_IMPORT SECStatus SSL_ShutdownServerSessionIDCache(void);
|
|
|
|
/*
|
|
** Set peer information so we can correctly look up SSL session later.
|
|
** You only have to do this if you're tunneling through a proxy.
|
|
*/
|
|
SSL_IMPORT SECStatus SSL_SetSockPeerID(PRFileDesc *fd, const char *peerID);
|
|
|
|
/*
|
|
** Reveal the security information for the peer.
|
|
*/
|
|
SSL_IMPORT CERTCertificate * SSL_RevealCert(PRFileDesc * socket);
|
|
SSL_IMPORT void * SSL_RevealPinArg(PRFileDesc * socket);
|
|
SSL_IMPORT char * SSL_RevealURL(PRFileDesc * socket);
|
|
|
|
/* This callback may be passed to the SSL library via a call to
|
|
* SSL_GetClientAuthDataHook() for each SSL client socket.
|
|
* It will be invoked when SSL needs to know what certificate and private key
|
|
* (if any) to use to respond to a request for client authentication.
|
|
* If arg is non-NULL, it is a pointer to a NULL-terminated string containing
|
|
* the nickname of the cert/key pair to use.
|
|
* If arg is NULL, this function will search the cert and key databases for
|
|
* a suitable match and send it if one is found.
|
|
*/
|
|
SSL_IMPORT SECStatus
|
|
NSS_GetClientAuthData(void * arg,
|
|
PRFileDesc * socket,
|
|
struct CERTDistNamesStr * caNames,
|
|
struct CERTCertificateStr ** pRetCert,
|
|
struct SECKEYPrivateKeyStr **pRetKey);
|
|
|
|
/*
|
|
* Look to see if any of the signers in the cert chain for "cert" are found
|
|
* in the list of caNames.
|
|
* Returns SECSuccess if so, SECFailure if not.
|
|
* Used by NSS_GetClientAuthData. May be used by other callback functions.
|
|
*/
|
|
SSL_IMPORT SECStatus NSS_CmpCertChainWCANames(CERTCertificate *cert,
|
|
CERTDistNames *caNames);
|
|
|
|
/*
|
|
* Returns key exchange type of the keys in an SSL server certificate.
|
|
*/
|
|
SSL_IMPORT SSLKEAType NSS_FindCertKEAType(CERTCertificate * cert);
|
|
|
|
/* Set cipher policies to a predefined Domestic (U.S.A.) policy.
|
|
* This essentially enables all supported ciphers.
|
|
*/
|
|
SSL_IMPORT SECStatus NSS_SetDomesticPolicy(void);
|
|
|
|
/* Set cipher policies to a predefined Policy that is exportable from the USA
|
|
* according to present U.S. policies as we understand them.
|
|
* See documentation for the list.
|
|
* Note that your particular application program may be able to obtain
|
|
* an export license with more or fewer capabilities than those allowed
|
|
* by this function. In that case, you should use SSL_SetPolicy()
|
|
* to explicitly allow those ciphers you may legally export.
|
|
*/
|
|
SSL_IMPORT SECStatus NSS_SetExportPolicy(void);
|
|
|
|
/* Set cipher policies to a predefined Policy that is exportable from the USA
|
|
* according to present U.S. policies as we understand them, and that the
|
|
* nation of France will permit to be imported into their country.
|
|
* See documentation for the list.
|
|
*/
|
|
SSL_IMPORT SECStatus NSS_SetFrancePolicy(void);
|
|
|
|
SSL_IMPORT SSL3Statistics * SSL_GetStatistics(void);
|
|
|
|
/* Report more information than SSL_SecurityStatus.
|
|
** Caller supplies the info struct. Function fills it in.
|
|
*/
|
|
SSL_IMPORT SECStatus SSL_GetChannelInfo(PRFileDesc *fd, SSLChannelInfo *info,
|
|
PRUintn len);
|
|
SSL_IMPORT SECStatus SSL_GetCipherSuiteInfo(PRUint16 cipherSuite,
|
|
SSLCipherSuiteInfo *info, PRUintn len);
|
|
|
|
/* Returnes negotiated through SNI host info. */
|
|
SSL_IMPORT SECItem *SSL_GetNegotiatedHostInfo(PRFileDesc *fd);
|
|
|
|
/*
|
|
** Return a new reference to the certificate that was most recently sent
|
|
** to the peer on this SSL/TLS connection, or NULL if none has been sent.
|
|
*/
|
|
SSL_IMPORT CERTCertificate * SSL_LocalCertificate(PRFileDesc *fd);
|
|
|
|
/* Test an SSL configuration to see if SSL_BYPASS_PKCS11 can be turned on.
|
|
** Check the key exchange algorithm for each cipher in the list to see if
|
|
** a master secret key can be extracted after being derived with the mechanism
|
|
** required by the protocolmask argument. If the KEA will use keys from the
|
|
** specified cert make sure the extract operation is attempted from the slot
|
|
** where the private key resides.
|
|
** If MS can be extracted for all ciphers, (*pcanbypass) is set to TRUE and
|
|
** SECSuccess is returned. In all other cases but one (*pcanbypass) is
|
|
** set to FALSE and SECFailure is returned.
|
|
** In that last case Derive() has been called successfully but the MS is null,
|
|
** CanBypass sets (*pcanbypass) to FALSE and returns SECSuccess indicating the
|
|
** arguments were all valid but the slot cannot be bypassed.
|
|
**
|
|
** Note: A TRUE return code from CanBypass means "Your configuration will perform
|
|
** NO WORSE with the bypass enabled than without"; it does NOT mean that every
|
|
** cipher suite listed will work properly with the selected protocols.
|
|
**
|
|
** Caveat: If export cipher suites are included in the argument list Canbypass
|
|
** will return FALSE.
|
|
**/
|
|
|
|
/* protocol mask bits */
|
|
#define SSL_CBP_SSL3 0x0001 /* test SSL v3 mechanisms */
|
|
#define SSL_CBP_TLS1_0 0x0002 /* test TLS v1.0 mechanisms */
|
|
|
|
SSL_IMPORT SECStatus SSL_CanBypass(CERTCertificate *cert,
|
|
SECKEYPrivateKey *privKey,
|
|
PRUint32 protocolmask,
|
|
PRUint16 *ciphers, int nciphers,
|
|
PRBool *pcanbypass, void *pwArg);
|
|
|
|
/*
|
|
** Did the handshake with the peer negotiate the given extension?
|
|
** Output parameter valid only if function returns SECSuccess
|
|
*/
|
|
SSL_IMPORT SECStatus SSL_HandshakeNegotiatedExtension(PRFileDesc * socket,
|
|
SSLExtensionType extId,
|
|
PRBool *yes);
|
|
|
|
SEC_END_PROTOS
|
|
|
|
#endif /* __ssl_h_ */
|