irods  4.2.8
About: iRODS (the integrated Rule Oriented Data System) is a distributed data-management system for creating data grids, digital libraries, persistent archives, and real-time data systems.
  Fossies Dox: irods-4.2.8.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

irods::gsi_auth_object Class Reference

#include <irods_gsi_object.hpp>

Inheritance diagram for irods::gsi_auth_object:
[legend]
Collaboration diagram for irods::gsi_auth_object:
[legend]

Public Member Functions

 gsi_auth_object (rError_t *_r_error)
 
virtual ~gsi_auth_object ()
 
virtual gss_cred_id_t creds (void) const
 
virtual int sock (void) const
 
virtual const std::string & server_dn (void) const
 
virtual const std::string & digest (void) const
 
virtual error get_re_vars (rule_engine_vars_t &)
 
virtual void creds (gss_cred_id_t _creds)
 
virtual void sock (int s)
 
virtual void server_dn (const std::string &s)
 
virtual void digest (const std::string &d)
 
error resolve (const std::string &_name, plugin_ptr &_plugin)
 
bool operator== (const gsi_auth_object &_rhs) const
 
- Public Member Functions inherited from irods::auth_object
 auth_object (rError_t *_r_error)
 
 auth_object (const auth_object &)
 
virtual ~auth_object ()
 
virtual auth_objectoperator= (const auth_object &_rhs)
 
virtual rError_tr_error (void) const
 
virtual std::string request_result () const
 
virtual void request_result (const std::string &_r)
 
virtual std::string context () const
 
virtual void context (const std::string &_c)
 
virtual std::string user_name () const
 
virtual std::string zone_name () const
 
virtual void user_name (const std::string &_un)
 
virtual void zone_name (const std::string &_zn)
 
virtual bool operator== (const auth_object &_rhs) const
 
- Public Member Functions inherited from irods::first_class_object
 first_class_object ()
 
virtual ~first_class_object ()
 

Private Attributes

gss_cred_id_t creds_
 
int sock_
 
std::string server_dn_
 
std::string digest_
 

Additional Inherited Members

- Protected Attributes inherited from irods::auth_object
rError_tr_error_
 
std::string request_result_
 =-=-=-=-=-=-=- More...
 
std::string user_name_
 
std::string zone_name_
 
std::string context_
 

Detailed Description

Description:\n Auth object for GSI authentication

Definition at line 18 of file irods_gsi_object.hpp.

Constructor & Destructor Documentation

◆ gsi_auth_object()

irods::gsi_auth_object::gsi_auth_object ( rError_t _r_error)
Description:\n Constructor

Definition at line 11 of file irods_gsi_object.cpp.

References creds_.

◆ ~gsi_auth_object()

irods::gsi_auth_object::~gsi_auth_object ( )
virtual

Definition at line 18 of file irods_gsi_object.cpp.

Member Function Documentation

◆ creds() [1/2]

virtual void irods::gsi_auth_object::creds ( gss_cred_id_t  _creds)
inlinevirtual
Description:\n Sets the GSI credentials

Definition at line 53 of file irods_gsi_object.hpp.

References creds_.

◆ creds() [2/2]

virtual gss_cred_id_t irods::gsi_auth_object::creds ( void  ) const
inlinevirtual
Description:\n Returns the GSI credentials

Definition at line 27 of file irods_gsi_object.hpp.

References creds_.

◆ digest() [1/2]

virtual void irods::gsi_auth_object::digest ( const std::string &  d)
inlinevirtual
Description:\n Sets the digest

Definition at line 68 of file irods_gsi_object.hpp.

References digest_.

◆ digest() [2/2]

virtual const std::string& irods::gsi_auth_object::digest ( void  ) const
inlinevirtual
Description:\n Returns the digest

Definition at line 42 of file irods_gsi_object.hpp.

References digest_.

◆ get_re_vars()

error irods::gsi_auth_object::get_re_vars ( rule_engine_vars_t _kvp)
virtual

=-=-=-=-=-=-=-

Description:\n serialize object to key-value pairs

Implements irods::auth_object.

Definition at line 53 of file irods_gsi_object.cpp.

References digest_, server_dn_, sock_, and SUCCESS.

◆ operator==()

bool irods::gsi_auth_object::operator== ( const gsi_auth_object _rhs) const
Description:\n Comparison operator

Definition at line 46 of file irods_gsi_object.cpp.

References creds_.

◆ resolve()

error irods::gsi_auth_object::resolve ( const std::string &  _interface,
plugin_ptr _ptr 
)
virtual
Description:\n undocumented

Implements irods::auth_object.

Definition at line 22 of file irods_gsi_object.cpp.

References ASSERT_ERROR, ASSERT_PASS, irods::AUTH_GSI_SCHEME(), irods::AUTH_INTERFACE(), irods::auth_mgr, irods::auth_manager::init_from_type(), irods::error::ok(), ProcessType, irods::auth_manager::resolve(), SUCCESS, and SYS_INVALID_INPUT_PARAM.

Here is the call graph for this function:

◆ server_dn() [1/2]

virtual void irods::gsi_auth_object::server_dn ( const std::string &  s)
inlinevirtual
Description:\n Sets the serverDN

Definition at line 63 of file irods_gsi_object.hpp.

References server_dn_.

◆ server_dn() [2/2]

virtual const std::string& irods::gsi_auth_object::server_dn ( void  ) const
inlinevirtual
Description:\n Returns the serverDN

Definition at line 37 of file irods_gsi_object.hpp.

References server_dn_.

◆ sock() [1/2]

virtual void irods::gsi_auth_object::sock ( int  s)
inlinevirtual
Description:\n Sets the socket number

Definition at line 58 of file irods_gsi_object.hpp.

References sock_.

◆ sock() [2/2]

virtual int irods::gsi_auth_object::sock ( void  ) const
inlinevirtual
Description:\n Returns the socket number

Definition at line 32 of file irods_gsi_object.hpp.

References sock_.

Member Data Documentation

◆ creds_

gss_cred_id_t irods::gsi_auth_object::creds_
private

Definition at line 82 of file irods_gsi_object.hpp.

Referenced by creds(), gsi_auth_object(), and operator==().

◆ digest_

std::string irods::gsi_auth_object::digest_
private

Definition at line 85 of file irods_gsi_object.hpp.

Referenced by digest(), and get_re_vars().

◆ server_dn_

std::string irods::gsi_auth_object::server_dn_
private

Definition at line 84 of file irods_gsi_object.hpp.

Referenced by get_re_vars(), and server_dn().

◆ sock_

int irods::gsi_auth_object::sock_
private

Definition at line 83 of file irods_gsi_object.hpp.

Referenced by get_re_vars(), and sock().


The documentation for this class was generated from the following files: