/usr/include/IceSSL/Plugin.h is in libzeroc-ice35-dev 3.5.1-6.4ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 | // **********************************************************************
//
// Copyright (c) 2003-2013 ZeroC, Inc. All rights reserved.
//
// This copy of Ice is licensed to you under the terms described in the
// ICE_LICENSE file included in this distribution.
//
// **********************************************************************
#ifndef ICE_SSL_PLUGIN_H
#define ICE_SSL_PLUGIN_H
#include <IceUtil/Time.h>
#include <Ice/Plugin.h>
#include <IceSSL/ConnectionInfo.h>
#include <vector>
#include <list>
// For struct sockaddr_storage
#ifdef _WIN32
# include <winsock2.h>
#else
# include <sys/socket.h>
#endif
#ifndef ICE_SSL_API
# ifdef ICE_SSL_API_EXPORTS
# define ICE_SSL_API ICE_DECLSPEC_EXPORT
# else
# define ICE_SSL_API ICE_DECLSPEC_IMPORT
# endif
#endif
//
// SSL_CTX is the OpenSSL type that holds configuration settings for
// all SSL connections.
//
typedef struct ssl_ctx_st SSL_CTX;
//
// X509 is the OpenSSL type that represents a certificate.
//
typedef struct x509_st X509;
typedef struct X509_name_st X509NAME;
//
// EVP_PKEY is the OpenSSL type that represents a public key.
//
typedef struct evp_pkey_st EVP_PKEY;
namespace IceSSL
{
//
// This exception is thrown if the certificate cannot be read.
//
class ICE_SSL_API CertificateReadException : public IceUtil::Exception
{
public:
CertificateReadException(const char*, int, const std::string&);
virtual ~CertificateReadException() throw();
virtual std::string ice_name() const;
virtual CertificateReadException* ice_clone() const;
virtual void ice_throw() const;
std::string reason;
private:
static const char* _name;
};
//
// This exception is thrown if the certificate cannot be encoded.
//
class ICE_SSL_API CertificateEncodingException : public IceUtil::Exception
{
public:
CertificateEncodingException(const char*, int, const std::string&);
virtual ~CertificateEncodingException() throw();
virtual std::string ice_name() const;
virtual CertificateEncodingException* ice_clone() const;
virtual void ice_throw() const;
std::string reason;
private:
static const char* _name;
};
//
// This exception is thrown if a distinguished name cannot be parsed.
//
class ICE_SSL_API ParseException : public IceUtil::Exception
{
public:
ParseException(const char*, int, const std::string&);
virtual ~ParseException() throw();
virtual std::string ice_name() const;
virtual ParseException* ice_clone() const;
virtual void ice_throw() const;
std::string reason;
private:
static const char* _name;
};
//
// Forward declaration.
//
class Certificate;
typedef IceUtil::Handle<Certificate> CertificatePtr;
//
// A representation of a PublicKey.
//
class ICE_SSL_API PublicKey : public IceUtil::Shared
{
public:
~PublicKey();
EVP_PKEY* key() const;
private:
PublicKey(EVP_PKEY*);
friend class Certificate;
EVP_PKEY* _key;
};
typedef IceUtil::Handle<PublicKey> PublicKeyPtr;
//
// This class represents a DistinguishedName, similar to the Java
// type X500Principal and the .NET type X500DistinguishedName.
//
// For comparison purposes, the value of a relative distinguished
// name (RDN) component is always unescaped before matching,
// therefore "ZeroC, Inc." will match ZeroC\, Inc.
//
// toString() always returns exactly the same information as was
// provided in the constructor (i.e., "ZeroC, Inc." will not turn
// into ZeroC\, Inc.).
//
class ICE_SSL_API DistinguishedName
{
public:
//
// Create a DistinguishedName using an OpenSSL value.
//
DistinguishedName(X509NAME*);
//
// Create a DistinguishedName from a string encoded using
// the rules in RFC2253.
//
// Throws ParseException if parsing fails.
//
DistinguishedName(const std::string&);
//
// Create a DistinguishedName from a list of RDN pairs,
// where each pair consists of the RDN's type and value.
// For example, the RDN "O=ZeroC" is represented by the
// pair ("O", "ZeroC").
//
DistinguishedName(const std::list<std::pair<std::string, std::string> >&);
//
// This is an exact match. The order of the RDN components is
// important.
//
bool operator==(const DistinguishedName&) const;
bool operator!=(const DistinguishedName&) const;
bool operator<(const DistinguishedName&) const;
//
// Perform a partial match with another DistinguishedName. The function
// returns true if all of the RDNs in the argument are present in this
// DistinguishedName and they have the same values.
//
bool match(const DistinguishedName&) const;
//
// Encode the DN in RFC2253 format.
//
operator std::string() const;
private:
void unescape();
std::list<std::pair<std::string, std::string> > _rdns;
std::list<std::pair<std::string, std::string> > _unescaped;
};
//
// This convenience class is a wrapper around OpenSSL's X509 type.
// The interface is inspired by java.security.cert.X509Certificate.
//
class ICE_SSL_API Certificate : public IceUtil::Shared
{
public:
//
// Construct a certificate using a X509*. The Certificate assumes
// ownership of the X509* struct.
//
Certificate(X509*);
~Certificate();
//
// Load the certificate from a file. The certificate must use the
// PEM encoding format. Raises CertificateReadException if the
// file cannot be read.
//
static CertificatePtr load(const std::string&);
//
// Decode a certificate from a string that uses the PEM encoding format.
// Raises CertificateEncodingException if an error occurs.
//
static CertificatePtr decode(const std::string&);
bool operator==(const Certificate&) const;
bool operator!=(const Certificate&) const;
//
// Get the certificate's public key.
//
PublicKeyPtr getPublicKey() const;
//
// Verify that this certificate was signed by the given public
// key. Returns true if signed, false otherwise.
//
bool verify(const PublicKeyPtr&) const;
//
// Return a string encoding of the certificate in PEM format.
// Raises CertificateEncodingException if an error occurs.
//
std::string encode() const;
//
// Checks that the certificate is currently valid, that is, the current
// date falls between the validity period given in the certificate.
//
bool checkValidity() const;
//
// Checks that the certificate is valid at the given time.
//
bool checkValidity(const IceUtil::Time&) const;
//
// Get the not-after validity time.
//
IceUtil::Time getNotAfter() const;
//
// Get the not-before validity time.
//
IceUtil::Time getNotBefore() const;
//
// Get the serial number. This is an arbitrarily large number.
//
std::string getSerialNumber() const;
//
// Get the signature algorithm name used to sign the certificate.
//
//std::string getSigAlgName() const;
//
// Get the signature algorithm OID string from the certificate.
//
//std::string getSigAlgOID() const;
//
// Get the issuer's distinguished name (DN).
//
DistinguishedName getIssuerDN() const;
//
// Get the values in the issuer's alternative names extension.
//
// The returned list contains a pair of int, string.
//
// otherName [0] OtherName
// rfc822Name [1] IA5String
// dNSName [2] IA5String
// x400Address [3] ORAddress
// directoryName [4] Name
// ediPartyName [5] EDIPartyName
// uniformResourceIdentifier [6] IA5String
// iPAddress [7] OCTET STRING
// registeredID [8] OBJECT IDENTIFIER
//
// rfc822Name, dNSName, directoryName and
// uniformResourceIdentifier data is returned as a string.
//
// iPAddress is returned in dotted quad notation. IPv6 is not
// currently supported.
//
// All distinguished names are encoded in RFC2253 format.
//
// The remainder of the data will result in an empty string. Use the raw
// X509* certificate to obtain these values.
//
std::vector<std::pair<int, std::string> > getIssuerAlternativeNames();
//
// Get the subject's distinguished name (DN).
//
DistinguishedName getSubjectDN() const;
//
// See the comment for getIssuerAlternativeNames.
//
std::vector<std::pair<int, std::string> > getSubjectAlternativeNames();
//
// Retrieve the certificate version number.
//
int getVersion() const;
//
// Stringify the certificate. This is a human readable version of
// the certificate, not a DER or PEM encoding.
//
std::string toString() const;
//
// Retrieve the X509 value wrapped by this object. The reference count
// of the X509 value is not incremented, therefore it is only valid
// for the lifetime of this object unless the caller increments its
// reference count explicitly using X509_dup.
//
X509* getCert() const;
private:
X509* _cert;
};
//
// NativeConnectionInfo is an extension of IceSSL::ConnectionInfo that
// provides access to native certificates.
//
class NativeConnectionInfo : public ConnectionInfo
{
public:
//
// The certificate chain. This may be empty if the peer did not
// supply a certificate. The peer's certificate (if any) is the
// first one in the chain.
//
std::vector<CertificatePtr> nativeCerts;
};
typedef IceUtil::Handle<NativeConnectionInfo> NativeConnectionInfoPtr;
//
// An application can customize the certificate verification process
// by implementing the CertificateVerifier interface.
//
class CertificateVerifier : public IceUtil::Shared
{
public:
//
// Return false if the connection should be rejected, or true to
// allow it.
//
virtual bool verify(const NativeConnectionInfoPtr&) = 0;
};
typedef IceUtil::Handle<CertificateVerifier> CertificateVerifierPtr;
//
// In order to read an encrypted file, such as one containing a
// private key, OpenSSL requests a password from IceSSL. The password
// can be defined using an IceSSL configuration property, but a
// plain-text password is a security risk. If a password is not
// supplied via configuration, IceSSL allows OpenSSL to prompt the
// user interactively. This may not be desirable (or even possible),
// so the application can supply an implementation of PasswordPrompt
// to take responsibility for obtaining the password.
//
// Note that the password is needed during plug-in initialization, so
// in general you will need to delay initialization (by defining
// IceSSL.DelayInit=1), configure the PasswordPrompt, then manually
// initialize the plug-in.
//
class PasswordPrompt : public IceUtil::Shared
{
public:
//
// The getPassword method may be invoked repeatedly, such as when
// several encrypted files are opened, or when multiple password
// attempts are allowed.
//
virtual std::string getPassword() = 0;
};
typedef IceUtil::Handle<PasswordPrompt> PasswordPromptPtr;
class Plugin : public Ice::Plugin
{
public:
//
// Establish the OpenSSL context. This must be done before the
// plug-in is initialized, therefore the application must define
// the property Ice.InitPlugins=0, set the context, and finally
// invoke initializePlugins on the PluginManager.
//
// When the application supplies its own OpenSSL context, the
// plug-in ignores configuration properties related to certificates,
// keys, and passwords.
//
// Note that the plugin assumes ownership of the given context.
//
virtual void setContext(SSL_CTX*) = 0;
//
// Obtain the SSL context. Use caution when modifying this value.
// Changes made to this value have no effect on existing connections.
//
virtual SSL_CTX* getContext() = 0;
//
// Establish the certificate verifier object. This should be done
// before any connections are established.
//
virtual void setCertificateVerifier(const CertificateVerifierPtr&) = 0;
//
// Establish the password prompt object. This must be done before
// the plug-in is initialized.
//
virtual void setPasswordPrompt(const PasswordPromptPtr&) = 0;
};
typedef IceUtil::Handle<Plugin> PluginPtr;
}
#endif
|