ChangeLogTag:Sat Jul 31 00:43:37 2004 Ossama Othman <ossama@dre.vanderbilt.edu>

1 files changed, 133 insertions, 275 deletions

diff --git a/TAO/orbsvcs/orbsvcs/SSLIOP/SSLIOP_Credentials.h b/TAO/orbsvcs/orbsvcs/SSLIOP/SSLIOP_Credentials.h
index 50722c09367..4a53212775d 100644
--- a/TAO/orbsvcs/orbsvcs/SSLIOP/SSLIOP_Credentials.h
+++ b/TAO/orbsvcs/orbsvcs/SSLIOP/SSLIOP_Credentials.h
@@ -6,7 +6,7 @@
  *
  *  $Id$
  *
- *  @author Ossama Othman <ossama@uci.edu>
+ *  @author Ossama Othman <ossama@dre.vanderbilt.edu>
  */
 //=============================================================================
 
@@ -23,286 +23,144 @@
 
 #include "SSLIOP_X509.h"
 #include "SSLIOP_EVP_PKEY.h"
+#include "orbsvcs/orbsvcs/SecurityLevel3C.h"
 #include "tao/LocalObject.h"
-#include "orbsvcs/orbsvcs/SecurityLevel2C.h"
 
+namespace TAO
+{
+  namespace SSLIOP
+  {
+
+    class Credentials;
+    typedef Credentials* Credentials_ptr;
+    typedef TAO_Pseudo_Var_T<Credentials> Credentials_var;
+    typedef TAO_Pseudo_Out_T<Credentials, Credentials_var> Credentials_out;
+
+    /**
+     * @class Credentials
+     *
+     * @brief SSLIOP-specific implementation of the
+     *        SecurityLevel3::Credentials interface.
+     *
+     * This class encapsulates the X.509 certificate associated with a
+     * given a principal.
+     */
+    class TAO_SSLIOP_Export Credentials
+      : public virtual SecurityLevel3::Credentials,
+        public virtual TAO_Local_RefCounted_Object
+    {
+    public:
 
-class TAO_SSLIOP_Credentials;
-typedef TAO_SSLIOP_Credentials* TAO_SSLIOP_Credentials_ptr;
+      /// Constructor
+      Credentials (::X509 * cert, ::EVP_PKEY * evp);
 
-class TAO_SSLIOP_Credentials_var : public TAO_Base_var
-{
-public:
-  TAO_SSLIOP_Credentials_var (void); // default constructor
-  TAO_SSLIOP_Credentials_var (TAO_SSLIOP_Credentials_ptr p) : ptr_ (p) {}
-  TAO_SSLIOP_Credentials_var (const TAO_SSLIOP_Credentials_var &); // copy constructor
-  ~TAO_SSLIOP_Credentials_var (void); // destructor
-
-  TAO_SSLIOP_Credentials_var &operator= (TAO_SSLIOP_Credentials_ptr);
-  TAO_SSLIOP_Credentials_var &operator= (const TAO_SSLIOP_Credentials_var &);
-  TAO_SSLIOP_Credentials_ptr operator-> (void) const;
-
-  operator const TAO_SSLIOP_Credentials_ptr &() const;
-  operator TAO_SSLIOP_Credentials_ptr &();
-  // in, inout, out, _retn
-  TAO_SSLIOP_Credentials_ptr in (void) const;
-  TAO_SSLIOP_Credentials_ptr &inout (void);
-  TAO_SSLIOP_Credentials_ptr &out (void);
-  TAO_SSLIOP_Credentials_ptr _retn (void);
-  TAO_SSLIOP_Credentials_ptr ptr (void) const;
-
-  // Hooks used by template sequence and object manager classes
-  // for non-defined forward declared interfaces.
-  static TAO_SSLIOP_Credentials_ptr tao_duplicate (TAO_SSLIOP_Credentials_ptr);
-  static void tao_release (TAO_SSLIOP_Credentials_ptr);
-  static TAO_SSLIOP_Credentials_ptr tao_nil (void);
-  static TAO_SSLIOP_Credentials_ptr tao_narrow (
-      CORBA::Object *
-      ACE_ENV_ARG_DECL_NOT_USED
-    );
-  static CORBA::Object * tao_upcast (void *);
-
-private:
-  TAO_SSLIOP_Credentials_ptr ptr_;
-  // Unimplemented - prevents widening assignment.
-  TAO_SSLIOP_Credentials_var (const TAO_Base_var &rhs);
-  TAO_SSLIOP_Credentials_var &operator= (const TAO_Base_var &rhs);
-};
-
-
-class  TAO_SSLIOP_Credentials_out
-{
-public:
-  TAO_SSLIOP_Credentials_out (TAO_SSLIOP_Credentials_ptr &);
-  TAO_SSLIOP_Credentials_out (TAO_SSLIOP_Credentials_var &);
-  TAO_SSLIOP_Credentials_out (const TAO_SSLIOP_Credentials_out &);
-  TAO_SSLIOP_Credentials_out &operator= (const TAO_SSLIOP_Credentials_out &);
-  TAO_SSLIOP_Credentials_out &operator= (const TAO_SSLIOP_Credentials_var &);
-  TAO_SSLIOP_Credentials_out &operator= (TAO_SSLIOP_Credentials_ptr);
-  operator TAO_SSLIOP_Credentials_ptr &();
-  TAO_SSLIOP_Credentials_ptr &ptr (void);
-  TAO_SSLIOP_Credentials_ptr operator-> (void);
-
-private:
-  TAO_SSLIOP_Credentials_ptr &ptr_;
-};
+      /**
+       * @name SecurityLevel3::Credentials Methods
+       *
+       * Methods required by the SecurityLevel3::Credentials
+       * interface.
+       */
+      //@{
+      virtual char * creds_id (ACE_ENV_SINGLE_ARG_DECL)
+        ACE_THROW_SPEC ((CORBA::SystemException));
 
+      virtual
+      SecurityLevel3::CredentialsType creds_type (ACE_ENV_SINGLE_ARG_DECL)
+        ACE_THROW_SPEC ((CORBA::SystemException)) = 0;
 
-/**
- * @class TAO_SSLIOP_Credentials
- *
- * @brief SSLIOP-specific implementation of the
- *        SecurityLevel2::Credentials interface.
- *
- * This class encapsulates the X.509 certificate associated with a
- * given a principal.
- */
-class TAO_SSLIOP_Credentials
-  : public virtual SecurityLevel2::Credentials,
-    public virtual TAO_Local_RefCounted_Object
-{
-public:
-
-  /// Constructor
-  TAO_SSLIOP_Credentials (X509 *cert, EVP_PKEY *evp);
-
-  /// Return a duplicate (specifically a deep copy) of this credential
-  /// object.
-  virtual SecurityLevel2::Credentials_ptr copy (
-      ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS)
-    ACE_THROW_SPEC ((CORBA::SystemException));
-
-  virtual void destroy (
-      ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS)
-    ACE_THROW_SPEC ((CORBA::SystemException));
-
-  /// Return the invocation credentials type this object is.
-  /**
-   * If this Credentials object was created by the
-   * PrincipalAuthenticator then the "own" credentials type
-   * (i.e. Security::SecOwnCredentials) is returned.  Specifically,
-   * the credentials represented by this Credentials object are our
-   * own, not the peer's credentials.
-   * @par
-   * If this Credentials object corresponds to the credentials
-   * received from the peer, then the "received" credentials type
-   * (i.e. Security::SecReceivedCredentials) is returned.
-   * @par
-   * If this Credentials object corresponds to the target object's
-   * credentials then the "target" credentials type
-   * (i.e. Security::SecTargetCredentials) is returned.
-   */
-  virtual Security::InvocationCredentialsType credentials_type (
-      ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS)
-    ACE_THROW_SPEC ((CORBA::SystemException));
-
-  virtual Security::AuthenticationStatus authentication_state (
-      ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS)
-    ACE_THROW_SPEC ((CORBA::SystemException));
-
-  virtual char * mechanism (
-      ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS)
-    ACE_THROW_SPEC ((CORBA::SystemException));
-
-  virtual Security::AssociationOptions accepting_options_supported (
-      ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS)
-    ACE_THROW_SPEC ((CORBA::SystemException));
-
-  virtual void accepting_options_supported (
-      Security::AssociationOptions accepting_options_supported
-      ACE_ENV_ARG_DECL_WITH_DEFAULTS)
-    ACE_THROW_SPEC ((CORBA::SystemException));
-
-  virtual Security::AssociationOptions accepting_options_required (
-      ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS)
-    ACE_THROW_SPEC ((CORBA::SystemException));
-
-  virtual void accepting_options_required (
-      Security::AssociationOptions accepting_options_required
-      ACE_ENV_ARG_DECL_WITH_DEFAULTS)
-    ACE_THROW_SPEC ((CORBA::SystemException));
-
-  virtual Security::AssociationOptions invocation_options_supported (
-      ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS)
-    ACE_THROW_SPEC ((CORBA::SystemException));
-
-  virtual void invocation_options_supported (
-      Security::AssociationOptions invocation_options_supported
-      ACE_ENV_ARG_DECL_WITH_DEFAULTS)
-    ACE_THROW_SPEC ((CORBA::SystemException));
-
-  virtual Security::AssociationOptions invocation_options_required (
-      ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS)
-    ACE_THROW_SPEC ((CORBA::SystemException));
-
-  virtual void invocation_options_required (
-      Security::AssociationOptions invocation_options_required
-      ACE_ENV_ARG_DECL_WITH_DEFAULTS)
-    ACE_THROW_SPEC ((CORBA::SystemException));
-
-  virtual CORBA::Boolean get_security_feature (
-      Security::CommunicationDirection direction,
-      Security::SecurityFeature feature
-      ACE_ENV_ARG_DECL_WITH_DEFAULTS)
-    ACE_THROW_SPEC ((CORBA::SystemException));
-
-  virtual CORBA::Boolean set_attributes (
-      const Security::AttributeList & requested_attributes,
-      Security::AttributeList_out actual_attributes
-      ACE_ENV_ARG_DECL_WITH_DEFAULTS)
-    ACE_THROW_SPEC ((CORBA::SystemException));
-
-  virtual Security::AttributeList * get_attributes (
-      const Security::AttributeTypeList & attributes
-      ACE_ENV_ARG_DECL_WITH_DEFAULTS)
-    ACE_THROW_SPEC ((CORBA::SystemException));
-
-  /// Verify that this credential is still valid.
-  virtual CORBA::Boolean is_valid (
-      Security::UtcT_out expiry_time
-      ACE_ENV_ARG_DECL_WITH_DEFAULTS)
-    ACE_THROW_SPEC ((CORBA::SystemException));
-
-  virtual CORBA::Boolean refresh (
-      const CORBA::Any & refresh_data
-      ACE_ENV_ARG_DECL_WITH_DEFAULTS)
-    ACE_THROW_SPEC ((CORBA::SystemException));
-
-  //@{
-  /// Return a pointer to the underlying X.509 certificate.
-  /**
-   * @note Caller owns the returned object.  Use a
-   *       TAO_SSLIOP_X509_var.
-   */
-  X509 *x509 (void);
-  //@}
-
-  /// Return a pointer to the underlying private key.
-  /**
-   * @return Non-zero value if private key is used.
-   *
-   * @note Caller owns the returned object.  Use a
-   *       TAO_SSLIOP_EVP_PKEY_var.
-   */
-  EVP_PKEY *evp (void);
-  //@}
-
-  bool operator== (const TAO_SSLIOP_Credentials &rhs);
-
-  CORBA::ULong hash (void) const;
-
-  //@{
-#if !defined(__GNUC__) || !defined (ACE_HAS_GNUG_PRE_2_8)
-  typedef TAO_SSLIOP_Credentials_ptr _ptr_type;
-  typedef TAO_SSLIOP_Credentials_var _var_type;
-#endif /* ! __GNUC__ || g++ >= 2.8 */
-
-  static int _tao_class_id;
-
-  // The static operations.
-  static TAO_SSLIOP_Credentials_ptr _duplicate (TAO_SSLIOP_Credentials_ptr obj);
-
-  static TAO_SSLIOP_Credentials_ptr _narrow (
-      CORBA::Object_ptr obj
-      ACE_ENV_ARG_DECL_WITH_DEFAULTS
-    );
-
-  static TAO_SSLIOP_Credentials_ptr _nil (void)
-    {
-      return (TAO_SSLIOP_Credentials_ptr)0;
-    }
-
-  //@}
-
-protected:
-
-  /// Destructor.
-  /**
-   * Destructor is protected to enforce proper reference counting.
-   * Specifically, this reference counted object should only be
-   * deallocated by the reference counting mechanism.
-   */
-  ~TAO_SSLIOP_Credentials (void);
-
-protected:
-
-  /// Security association options supported by this Credentials
-  /// object when accepting client invocations.
-  /**
-   * This attribute corresponds to the SSLIOP::target_supports field
-   * in the security association options in the SSLIOP tagged
-   * component that is embedded in IORs created by SSLIOP-enabled
-   * server side ORBs.
-   */
-  Security::AssociationOptions accepting_options_supported_;
-
-  /// Security association options required by this Credentials
-  /// object when accepting client invocations.
-  /**
-   * This attribute corresponds to the SSLIOP::target_requires field
-   * in the security association options in the SSLIOP tagged
-   * component that is embedded in IORs created by SSLIOP-enabled
-   * server side ORBs.
-   */
-  Security::AssociationOptions accepting_options_required_;
-
-  /// Security association options supported by this Credentials
-  /// object when invoking operations on the target object.
-  Security::AssociationOptions invocation_options_supported_;
-
-  /// Security association options required by this Credentials
-  /// object when invoking operations on the target object.
-  Security::AssociationOptions invocation_options_required_;
-
-  /// Reference to the X.509 certificate associated with this SSLIOP
-  /// Credentials object.
-  TAO_SSLIOP_X509_var x509_;
-
-  /// Reference to the private key associated with the X.509
-  /// certificate.
-  TAO_SSLIOP_EVP_PKEY_var evp_;
-
-};
+      virtual SecurityLevel3::CredentialsUsage creds_usage (
+          ACE_ENV_SINGLE_ARG_DECL)
+        ACE_THROW_SPEC ((CORBA::SystemException));
+
+      virtual TimeBase::UtcT expiry_time (ACE_ENV_SINGLE_ARG_DECL)
+        ACE_THROW_SPEC ((CORBA::SystemException));
+
+      virtual SecurityLevel3::CredentialsState creds_state (
+          ACE_ENV_SINGLE_ARG_DECL)
+        ACE_THROW_SPEC ((CORBA::SystemException));
+
+      virtual char * add_relinquished_listener (
+          SecurityLevel3::RelinquishedCredentialsListener_ptr listener
+          ACE_ENV_ARG_DECL)
+        ACE_THROW_SPEC ((CORBA::SystemException));
+
+      virtual void remove_relinquished_listener (const char * id
+                                                 ACE_ENV_ARG_DECL)
+        ACE_THROW_SPEC ((CORBA::SystemException));
+      //@}
+
+
+      //@{
+      /// Return a pointer to the underlying X.509 certificate.
+      /**
+       * @note Caller owns the returned object.  Use a
+       *       TAO::SSLIOP::X509_var.
+       */
+      ::X509 *x509 (void);
+      //@}
+
+      /// Return a pointer to the underlying private key.
+      /**
+       * @return Non-zero value if private key is used.
+       *
+       * @note Caller owns the returned object.  Use a
+       *       TAO::SSLIOP::EVP_PKEY_var.
+       */
+      ::EVP_PKEY *evp (void);
+      //@}
+
+      bool operator== (const Credentials &rhs);
+
+      CORBA::ULong hash (void) const;
+
+      // The static operations.
+      static Credentials_ptr _duplicate (Credentials_ptr obj);
+
+      static Credentials_ptr _narrow (CORBA::Object_ptr obj
+                                      ACE_ENV_ARG_DECL);
+
+      static Credentials_ptr _nil (void)
+      {
+        return (Credentials_ptr) 0;
+      }
+
+      //@}
+
+    protected:
+
+      /// Destructor.
+      /**
+       * Protected destructor to enforce proper memory management
+       * through the reference counting  mechanism.
+       */
+      ~Credentials (void);
+
+    protected:
+
+      /// Reference to the X.509 certificate associated with this SSLIOP
+      /// Credentials object.
+      X509_var x509_;
+
+      /// Reference to the private key associated with the X.509
+      /// certificate.
+      EVP_PKEY_var evp_;
+
+      /// Credentials Identifier.
+      CORBA::String_var id_;
+
+      /// The intended usage of the Credentials.
+      SecurityLevel3::CredentialsUsage creds_usage_;
+
+      /// The time these Credentials expire.
+      TimeBase::UtcT expiry_time_;
+
+      /// The validity of the Credentials.
+      SecurityLevel3::CredentialsState creds_state_;
+
+    };
+
+  } // End SSLIOP namespace
+}   // End TAO namespace
 
 #if defined (__ACE_INLINE__)
 # include "SSLIOP_Credentials.inl"