File: httpContext.h

package info (click to toggle)
omniorb-dfsg 4.3.3%2Bds1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 13,172 kB
  • sloc: cpp: 115,843; python: 24,962; ansic: 13,414; sh: 2,665; makefile: 40
file content (193 lines) | stat: -rw-r--r-- 6,164 bytes parent folder | download | duplicates (2)
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
// -*- Mode: C++; -*-
//                            Package   : omniORB
// httpContext.h              Created on: 27 April 2018
//                            Author    : Duncan Grisby
//
//    Copyright (C) 2003-2019 Apasphere Ltd
//    Copyright (C) 2018      Apasphere Ltd, BMC Software
//    Copyright (C) 2001      AT&T Laboratories Cambridge
//
//    This file is part of the omniORB library
//
//    The omniORB library is free software; you can redistribute it and/or
//    modify it under the terms of the GNU Lesser General Public
//    License as published by the Free Software Foundation; either
//    version 2.1 of the License, or (at your option) any later version.
//
//    This library is distributed in the hope that it will be useful,
//    but WITHOUT ANY WARRANTY; without even the implied warranty of
//    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
//    Lesser General Public License for more details.
//
//    You should have received a copy of the GNU Lesser General Public
//    License along with this library. If not, see http://www.gnu.org/licenses/
//
//
// Description:
//	*** PROPRIETARY INTERFACE ***
// 

#ifndef __HTTPCONTEXT_H__
#define __HTTPCONTEXT_H__

#include <omniORB4/linkHacks.h>
#include <omniORB4/sslContext.h>
#include <omniORB4/httpCrypto.h>

OMNI_FORCE_LINK(omnihttpTP);


#ifdef _core_attr
# error "A local CPP macro _core_attr has already been defined."
#endif

#if defined(_OMNIORB_HTTP_LIBRARY)
#     define _core_attr
#else
#     define _core_attr _OMNIORB_NTDLL_IMPORT
#endif

OMNI_NAMESPACE_BEGIN(omni)

class httpConnection;

class httpContext : public sslContext {
public:

  static _core_attr httpContext* singleton;

  // httpContext singleton object. This object is used to manage all
  // HTTPS connections in the HTTP transport, and control use of HTTP
  // proxies.
  //
  // Application code can populate this pointer with a suitable
  // httpContext object prior to calling CORBA::ORB_init. If it is not
  // set, a default instance is created. This base class uses the
  // global variables defined below to initialise itself, but an
  // application-provided subclass may behave differently.
  //
  // The singleton is deleted by ORB::destroy(). If the application
  // provides its own object here, and it calls ORB::destroy(), it
  // must set the singleton again if it is going to call ORB_init()
  // again.

  // HTTP proxy

  static _core_attr const char* proxy_url;
  static _core_attr const char* proxy_username;
  static _core_attr const char* proxy_password;
  
  
  // HTTPS certificates and keys

  static _core_attr const char* certificate_authority_file; // In PEM format
  static _core_attr const char* certificate_authority_path; // Path
  static _core_attr const char* key_file;                   // In PEM format
  static _core_attr const char* key_file_password;
  static _core_attr const char* cipher_list;
  
  // These parameters can be overriden to adjust the verify mode and
  // verify callback passed to SSL_CTX_set_verify and the info
  // callback passed to SSL_CTX_set_info_callback.
  //
  // If verify_mode_incoming is not -1 (the default), then incoming
  // connections (i.e. connections accepted by a server) are given
  // that mode instead of verify_mode.
  
  static _core_attr int            verify_mode;
  static _core_attr int            verify_mode_incoming;
  static _core_attr omni_verify_cb verify_callback;
  static _core_attr omni_info_cb   info_callback;


  // Manager for in-message crypto

  static _core_attr httpCryptoManager* crypto_manager;

  
  // Interceptor peerdetails calls return this structure:

  class PeerDetails {
  public:
    inline PeerDetails(SSL* s, X509* c, CORBA::Boolean v)
      : pd_ssl(s), pd_cert(c), pd_verified(v), pd_host_header(0),
        pd_crypto(0) {}

    ~PeerDetails();

    inline SSL*           ssl()         { return pd_ssl; }
    inline X509*          cert()        { return pd_cert; }
    inline CORBA::Boolean verified()    { return pd_verified; }
    inline const char*    host_header() { return pd_host_header; }
    inline httpCrypto*    crypto()      { return pd_crypto; }

  private:
    SSL*           pd_ssl;
    X509*          pd_cert;
    CORBA::Boolean pd_verified;
    const char*    pd_host_header;
    httpCrypto*    pd_crypto;

    friend class httpConnection;
  };

  
  httpContext(const char* cafile, const char* capath,
              const char* keyfile, const char* password);
  // Construct with CA file, CA path, key and password. All may be zero.

  httpContext();
  // Construct with details from the global variables.
  
  virtual ~httpContext();

  void update_proxy(const char* url,
                    const char* username, const char* password);
  // Update proxy details

  inline void set_proxy_auth(const char* auth)
  {
    pd_proxy_auth = auth;
  }
  // Set a custom value for the Proxy-Authorization header


  //
  // Methods used internally
  
  CORBA::Boolean proxy_info(char*&          url,
                            char*&          host,
                            CORBA::UShort&  port,
                            char*&          auth,
                            CORBA::Boolean& secure);
  // If a proxy is configured, returns true and populates url, host,
  // port, auth, secure. If the proxy requires basic authentication,
  // auth is set to the value that should be set in the Proxy-
  // Authorization header (i.e. base64 encoded username:password);
  // otherwise, auth is set to null.
  //
  // If no proxy is configured, returns false.

  virtual void copy_globals(CORBA::Boolean include_keys);

  static char* b64encode(const char* data, size_t len);
  static char* b64decode(const char* data, size_t& len);
  
protected:
  virtual const char* ctxType();
  
  void real_update_proxy(const char* url,
                         const char* username, const char* password);

  CORBA::String_var pd_proxy_url;
  CORBA::String_var pd_proxy_host;
  CORBA::UShort     pd_proxy_port;
  CORBA::String_var pd_proxy_auth;
  CORBA::Boolean    pd_proxy_secure;
};

OMNI_NAMESPACE_END(omni)

#undef _core_attr

#endif // __HTTPCONTEXT_H__