summaryrefslogtreecommitdiff
path: root/TAO/orbsvcs/orbsvcs/SSLIOP/SSLIOP_Profile.h
blob: d0d71834ba6d550baae107fc9ff6240454992f9a (plain)
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
// -*- C++ -*-

//=============================================================================
/**
 *  @file SSLIOP_Profile.h
 *
 *  $Id$
 *
 *  SSLIOP profile specific processing
 *
 *  @author Carlos O'Ryan <coryan@uci.edu>
 *  @author Ossama Othman <ossama@uci.edu>
 */
//=============================================================================


#ifndef TAO_SSLIOP_PROFILE_H
#define TAO_SSLIOP_PROFILE_H

#include "ace/pre.h"

#include "ace/config-all.h"

#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */

#include "SSLIOP_Endpoint.h"
#include "tao/IIOP_Profile.h"

class TAO_SSLIOP_Client_Connection_Handler;

/**
 * @class TAO_SSLIOP_Profile
 *
 * @brief This class defines the protocol specific attributes required
 * for locating ORBs over a TCP/IP network, using either IIOP or
 * IIOP/SSL for communication.
 *
 * This class extends TAO_IIOP_Profile to support secure
 * communication using SSL.
 */
class TAO_SSLIOP_Export TAO_SSLIOP_Profile : public TAO_IIOP_Profile
{
public:
  /// Profile constructor, same as above except the object_key has
  /// already been marshaled.
  TAO_SSLIOP_Profile (const ACE_INET_Addr & addr,
                      const TAO::ObjectKey & object_key,
                      const TAO_GIOP_Message_Version & version,
                      TAO_ORB_Core * orb_core,
                      const SSLIOP::SSL * ssl_component);

  ///  Profile constructor, this is the most efficient since it
  /// doesn't require any address resolution processing.
  TAO_SSLIOP_Profile (const char *host,
                      CORBA::UShort port,
                      const TAO::ObjectKey & object_key,
                      const ACE_INET_Addr & addr,
                      const TAO_GIOP_Message_Version & version,
                      TAO_ORB_Core * orb_core,
                      const SSLIOP::SSL * ssl_component);

  /// Create profile with the given SSLIOP tagged component.
  TAO_SSLIOP_Profile (TAO_ORB_Core * orb_core,
                      const SSLIOP::SSL * ssl_component);

  /// Profile constructor, default.
  TAO_SSLIOP_Profile (TAO_ORB_Core * orb_core);

  /// Destructor is to be called only through _decr_refcnt().
  ~TAO_SSLIOP_Profile (void);

  // = Please see Profile.h for the documentation of these methods.
  /**
   * Encodes this profile's endpoints into a tagged component.
   * This is done only if RTCORBA is enabled, since currently this is
   * the only case when we have more than one endpoint per profile.
   * Return 0 on success, -1 on failure.
   *@par
   * SSL endpoints are transmitted using TAO-proprietary tagged component.
   * Component tag is TAO_TAG_SSL_ENDPOINTS and component data is an
   * encapsulation of a sequence of structs, each representing a
   * single endpoint.  Data format is specified in ssl_endpoins.pidl.
   */
  virtual int decode (TAO_InputCDR& cdr);
  virtual int encode_endpoints (void);

  virtual CORBA::Boolean is_equivalent (const TAO_Profile * other_profile);

  /// Return pointer to the head of this profile's endpoints list,
  /// i.e., <ssl_endpoint_> accessor.
  virtual TAO_Endpoint *endpoint (void);

  /**
   * Override parse_string() from the base class to update the ssl
   * endpoint's iiop endpoint once the base class has completed parsing
   * the string.
   *@par
   * Initialize this object using the given input string.
   * Url-style string contain only one endpoint.
   */
  virtual void parse_string (const char * string
                             ACE_ENV_ARG_DECL);

  /**
   * Add <endp> to this profile's list of endpoints (it is inserted
   * next to the head of the list).  This profiles takes ownership of
   * <endp>.  If <endp>'s <iiop_endpoint_> member is not 0, it is
   * added to our parent's class endpoint list.
   */
  void add_endpoint (TAO_SSLIOP_Endpoint * endp);

private:

  /**
   * Helper for <decode>.  Decodes endpoints from a tagged component.
   * Decode only if RTCORBA is enabled.  Return 0 on success and -1 on
   * failure.
   */
  int decode_endpoints (void);

  /**
   * Head of this profile's list of endpoints.  This endpoint is not
   * dynamically allocated because a profile always contains at least
   * one endpoint.
   * @par
   * Currently, a profile contains more than one endpoint, i.e., list
   * contains more than just the head, only when RTCORBA is enabled.
   * However, in the near future, this will be used in nonRT mode as
   * well, e.g., to support TAG_ALTERNATE_IIOP_ADDRESS feature.
   * @par
   * Since SSLIOP profile is an extension of IIOP profile, its
   * addressing info is contained in two places:  IIOP parent class
   * contains all iiop addressing while this class contains
   * ssl-specific addressing additions to iiop.  This means that
   * there are two lists of endpoints: one maintained in the parent
   * class and one maintained here.  Each ssl endpoint maintains a
   * pointer to its counterpart in the parent class endpoint list.
   * @par
   * For transmission of iiop addressing information, see
   * TAO_IIOP_Profile.  Addressing info of the default ssl endpoint,
   * i.e., head of the list, is transmitted using standard
   * SSLIOP::TAG_SSL_SEC_TRANS tagged component.  See
   * <encode_endpoints> method documentation above for how the rest of
   * the ssl endpoint list is transmitted.
   */
  TAO_SSLIOP_Endpoint ssl_endpoint_;
};

#if defined (__ACE_INLINE__)
# include "SSLIOP_Profile.i"
#endif /* __ACE_INLINE__ */

#include "ace/post.h"

#endif  /* TAO_SSLIOP_PROFILE_H */