Definition at line 52 of file TAuthenticate.h.

Public Types
enum	ESecurity { kClear , kUnsupported , kKrb5 , kGlobus , kSSH , kRfio }

Public Types inherited from TObject
enum	{ kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff }

enum	{ kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) }

enum	EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }

enum	EStatusBits { kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) , kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 )) }

Public Member Functions
	TAuthenticate (TSocket sock, const char remote, const char proto, const char user="")
	Create authentication object.

virtual	~TAuthenticate ()

Bool_t	Authenticate ()
	Authenticate to remote rootd server.

Int_t	AuthExists (TString User, Int_t method, const char Options, Int_t Message, Int_t *Rflag, CheckSecCtx_t funcheck)
	Check if we have a valid established sec context in memory Retrieves relevant info and negotiates with server.

void	CatchTimeOut ()
	Called in connection with a timer timeout.

Bool_t	CheckNetrc (TString &user, TString &passwd)
	Try to get user name and passwd from the ~/.rootnetrc or ~/.netrc files.

Bool_t	CheckNetrc (TString &user, TString &passwd, Bool_t &pwhash, Bool_t srppwd)
	Try to get user name and passwd from the ~/.rootnetrc or ~/.netrc files.

THostAuth *	GetHostAuth () const

const char *	GetProtocol () const

const char *	GetRemoteHost () const

Int_t	GetRSAKeyType () const

TRootSecContext *	GetSecContext () const

TSocket *	GetSocket () const

const char *	GetUser () const

Int_t	HasTimedOut () const

TClass *	IsA () const override

void	SetRSAKeyType (Int_t key)

void	SetSecContext (TRootSecContext *ctx)

void	Streamer (TBuffer &) override
	Stream an object of class TObject.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TObject
	TObject ()
	TObject constructor.

	TObject (const TObject &object) noexcept
	TObject copy ctor.

virtual	~TObject ()
	TObject destructor.

void	AbstractMethod (const char *method) const
	Call this function within a function that you don't want to define as purely virtual, in order not to force all users deriving from that class to implement that maybe (on their side) unused function; but at the same time, emit a run-time warning if they try to call it, telling that it is not implemented in the derived class: action must thus be taken on the user side to override it.

virtual void	AppendPad (Option_t *option="")
	Append graphics object to current pad.

virtual void	Browse (TBrowser *b)
	Browse object. May be overridden for another default action.

ULong_t	CheckedHash ()
	Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.

virtual const char *	ClassName () const
	Returns name of class to which the object belongs.

virtual void	Clear (Option_t *="")

virtual TObject *	Clone (const char *newname="") const
	Make a clone of an object using the Streamer facility.

virtual Int_t	Compare (const TObject *obj) const
	Compare abstract method.

virtual void	Copy (TObject &object) const
	Copy this to obj.

virtual void	Delete (Option_t *option="")
	Delete this object.

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Computes distance from point (px,py) to the object.

virtual void	Draw (Option_t *option="")
	Default Draw method for all objects.

virtual void	DrawClass () const
	Draw class inheritance tree of the class to which this object belongs.

virtual TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current selected pad with: `gROOT->SetSelectedPad(c1)`.

virtual void	Dump () const
	Dump contents of object on stdout.

virtual void	Error (const char method, const char msgfmt,...) const
	Issue error message.

virtual void	Execute (const char method, const char params, Int_t *error=nullptr)
	Execute method on this object with the given parameter string, e.g.

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=nullptr)
	Execute method on this object with parameters stored in the TObjArray.

virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)
	Execute action corresponding to an event at (px,py).

virtual void	Fatal (const char method, const char msgfmt,...) const
	Issue fatal error message.

virtual TObject *	FindObject (const char *name) const
	Must be redefined in derived classes.

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes.

virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object.

virtual const char *	GetIconName () const
	Returns mime type name of object.

virtual const char *	GetName () const
	Returns name of object.

virtual char *	GetObjectInfo (Int_t px, Int_t py) const
	Returns string containing info about the object at position (px,py).

virtual Option_t *	GetOption () const

virtual const char *	GetTitle () const
	Returns title of object.

virtual UInt_t	GetUniqueID () const
	Return the unique object id.

virtual Bool_t	HandleTimer (TTimer *timer)
	Execute action in response of a timer timing out.

virtual ULong_t	Hash () const
	Return hash value for this object.

Bool_t	HasInconsistentHash () const
	Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.

virtual void	Info (const char method, const char msgfmt,...) const
	Issue info message.

virtual Bool_t	InheritsFrom (const char *classname) const
	Returns kTRUE if object inherits from class "classname".

virtual Bool_t	InheritsFrom (const TClass *cl) const
	Returns kTRUE if object inherits from TClass cl.

virtual void	Inspect () const
	Dump contents of this object in a graphics canvas.

void	InvertBit (UInt_t f)

Bool_t	IsDestructed () const
	IsDestructed.

virtual Bool_t	IsEqual (const TObject *obj) const
	Default equal comparison (objects are equal if they have the same address in memory).

virtual Bool_t	IsFolder () const
	Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).

R__ALWAYS_INLINE Bool_t	IsOnHeap () const

virtual Bool_t	IsSortable () const

R__ALWAYS_INLINE Bool_t	IsZombie () const

virtual void	ls (Option_t *option="") const
	The ls function lists the contents of a class on stdout.

void	MayNotUse (const char *method) const
	Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary).

virtual Bool_t	Notify ()
	This method must be overridden to handle object notification (the base implementation is no-op).

void	Obsolete (const char method, const char asOfVers, const char *removedFromVers) const
	Use this method to declare a method obsolete.

void	operator delete (void *, size_t)
	Operator delete for sized deallocation.

void	operator delete (void *ptr)
	Operator delete.

void	operator delete (void ptr, void vp)
	Only called by placement new when throwing an exception.

void	operator delete[] (void *, size_t)
	Operator delete [] for sized deallocation.

void	operator delete[] (void *ptr)
	Operator delete [].

void	operator delete[] (void ptr, void vp)
	Only called by placement new[] when throwing an exception.

void *	operator new (size_t sz)

void *	operator new (size_t sz, void *vp)

void *	operator new[] (size_t sz)

void *	operator new[] (size_t sz, void *vp)

TObject &	operator= (const TObject &rhs) noexcept
	TObject assignment operator.

virtual void	Paint (Option_t *option="")
	This method must be overridden if a class wants to paint itself.

virtual void	Pop ()
	Pop on object drawn in a pad to the top of the display list.

virtual void	Print (Option_t *option="") const
	This method must be overridden when a class wants to print itself.

virtual Int_t	Read (const char *name)
	Read contents of object with specified name from the current directory.

virtual void	RecursiveRemove (TObject *obj)
	Recursively remove this object from a list.

void	ResetBit (UInt_t f)

virtual void	SaveAs (const char filename="", Option_t option="") const
	Save this object in the file specified by filename.

virtual void	SavePrimitive (std::ostream &out, Option_t *option="")
	Save a primitive as a C++ statement(s) on output stream "out".

void	SetBit (UInt_t f)

void	SetBit (UInt_t f, Bool_t set)
	Set or unset the user status bits as specified in f.

virtual void	SetDrawOption (Option_t *option="")
	Set drawing option for object.

virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

virtual void	SysError (const char method, const char msgfmt,...) const
	Issue system error message.

R__ALWAYS_INLINE Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

virtual void	UseCurrentStyle ()
	Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.

virtual void	Warning (const char method, const char msgfmt,...) const
	Issue warning message.

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory.

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory.

Static Public Member Functions
static void	AuthError (const char *where, Int_t error)
	Print error string depending on error code.

static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

static Int_t	DecodeRSAPublic (const char rsapubexport, R__rsa_NUMBER &n, R__rsa_NUMBER &d, char *rsassl=nullptr)
	Store RSA public keys from export string rsaPubExport.

static TList *	GetAuthInfo ()
	Static method returning the list with authentication details.

static const char *	GetAuthMethod (Int_t idx)
	Static method returning the method corresponding to idx.

static Int_t	GetAuthMethodIdx (const char *meth)
	Static method returning the method index (which can be used to find the method in GetAuthMethod()).

static Bool_t	GetAuthReUse ()
	Static method returning the authentication reuse settings.

static Int_t	GetClientProtocol ()
	Static method returning supported client protocol.

static char *	GetDefaultDetails (Int_t method, Int_t opt, const char *user)
	Determine default authentication details for method 'sec' and user 'usr'.

static const char *	GetDefaultUser ()
	Static method returning the default user information.

static TDatime	GetGlobalExpDate ()
	Static method returning default expiring date for new validity contexts.

static Bool_t	GetGlobalPwHash ()
	Static method returning the global password hash flag.

static Bool_t	GetGlobalSRPPwd ()
	Static method returning the global SRP password flag.

static const char *	GetGlobalUser ()
	Static method returning the global user.

static GlobusAuth_t	GetGlobusAuthHook ()
	Static method returning the globus authorization hook (no longer supported)

static THostAuth *	GetHostAuth (const char host, const char user="", Option_t opt="R", Int_t Exact=nullptr)
	Sets fUser=user and search fgAuthInfo for the entry pertaining to (host,user), setting fHostAuth accordingly.

static const char *	GetKrb5Principal ()
	Static method returning the principal to be used to init Krb5 tickets.

static Bool_t	GetPromptUser ()
	Static method returning the prompt user settings.

static Int_t	GetRSAInit ()
	Static method returning the RSA initialization flag.

static const char *	GetRSAPubExport (Int_t key=0)
	Static method returning the RSA public keys.

static THostAuth *	HasHostAuth (const char host, const char user, Option_t *opt="R")
	Checks if a THostAuth with exact match for {host,user} exists in the fgAuthInfo list Returns pointer to it or 0.

static void	InitRandom ()
	Initialize random machine using seed from /dev/urandom (or current time if /dev/urandom not available).

static void	MergeHostAuthList (TList Std, TList New, Option_t *Opt="")
	Tool for updating fgAuthInfo 'nin' contains list of last input information through (re)reading of a rootauthrc-alike file.

static char *	PromptPasswd (const char *prompt="Password: ")
	Static method to prompt for the user's passwd to be used for authentication to rootd.

static char *	PromptUser (const char *remote)
	Static method to prompt for the user name to be used for authentication to rootd.

static Int_t	ReadRootAuthrc ()
	Read authentication directives from $ROOTAUTHRC, $HOME/.rootauthrc or `<Root_etc_dir>/system.rootauthrc` and create related THostAuth objects.

static void	RemoveHostAuth (THostAuth ha, Option_t opt="")
	Remove THostAuth instance from the list.

static Int_t	SecureRecv (TSocket Socket, Int_t dec, Int_t KeyType, char *Out)
	Receive str from sock and decode it using key indicated by key type Return number of received bytes or -1 in case of error.

static Int_t	SecureSend (TSocket Socket, Int_t enc, Int_t KeyType, const char In)
	Encode null terminated str using the session private key indicated by enc and sends it over the network Returns number of bytes sent, or -1 in case of error.

static Int_t	SendRSAPublicKey (TSocket *Socket, Int_t key=0)
	Receives server RSA Public key Sends local RSA public key encoded.

static void	SetAuthReUse (Bool_t authreuse)
	Set global AuthReUse flag.

static void	SetDefaultRSAKeyType (Int_t key)
	Static method setting the default type of RSA key.

static void	SetDefaultUser (const char *defaultuser)
	Set default user name.

static void	SetGlobalExpDate (TDatime expdate)
	Set default expiring date for new validity contexts.

static void	SetGlobalPasswd (const char *passwd)
	Set global passwd to be used for authentication to rootd.

static void	SetGlobalPwHash (Bool_t pwhash)
	Set global passwd hash flag to be used for authentication to rootd.

static void	SetGlobalSRPPwd (Bool_t srppwd)
	Set global SRP passwd flag to be used for authentication to rootd.

static void	SetGlobalUser (const char *user)
	Set global user name to be used for authentication to rootd.

static void	SetGlobusAuthHook (GlobusAuth_t func)
	Set Globus authorization function.

static void	SetKrb5AuthHook (Krb5Auth_t func)
	Set kerberos5 authorization function.

static void	SetPromptUser (Bool_t promptuser)
	Set global PromptUser flag.

static void	SetRSAInit (Int_t init=1)
	Static method setting RSA initialization flag.

static Int_t	SetRSAPublic (const char *rsapubexport, Int_t klen)
	Store RSA public keys from export string rsaPubExport.

static void	SetSecureAuthHook (SecureAuth_t func)
	Set secure authorization function.

static void	SetTimeOut (Int_t to)
	Set timeout (active if > 0)

static void	Show (Option_t *opt="S")
	Print info about the authentication sector.

Static Public Member Functions inherited from TObject
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

static Longptr_t	GetDtorOnly ()
	Return destructor only flag.

static Bool_t	GetObjectStat ()
	Get status of object stat flag.

static void	SetDtorOnly (void *obj)
	Set destructor only flag.

static void	SetObjectStat (Bool_t stat)
	Turn on/off tracking of objects in the TObjectTable.

Private Member Functions
Int_t	ClearAuth (TString &user, TString &passwd, Bool_t &pwhash)
	UsrPwd client authentication code.

Int_t	GenRSAKeys ()
	Generate a valid pair of private/public RSA keys to protect for authentication token exchange.

Bool_t	GetPwHash () const

char *	GetRandString (Int_t Opt, Int_t Len)
	Allocates and fills a 0 terminated buffer of length len+1 with len random characters.

Int_t	GetRSAKey () const

ESecurity	GetSecurity () const

Bool_t	GetSRPPwd () const

const char *	GetSshUser (TString user) const
	Method returning the user to be used for the ssh login (no longer supported)

Bool_t	GetUserPasswd (TString &user, TString &passwd, Bool_t &pwhash, Bool_t srppwd)
	Try to get user name and passwd from several sources.

Int_t	GetVersion () const

Int_t	RfioAuth (TString &user)
	RFIO authentication (no longer supported)

void	SetEnvironment ()
	Set default authentication environment.

Int_t	SshAuth (TString &user)
	SSH client authentication code (no longer supported)

Int_t	SshError (const char *errfile)

Static Private Member Functions
static Bool_t	CheckHost (const char Host, const char host)
	Check if 'host' matches 'href': this means either equal or "containing" it, even with wild cards * in the first field (in the case 'href' is a name, ie not IP address) Returns kTRUE if the two matches.

static void	FileExpand (const char fin, FILE ftmp)
	Expands include directives found in fexp files The expanded, temporary file, is pointed to by 'ftmp' and should be already open.

static void	RemoveSecContext (TRootSecContext *ctx)
	Tool for removing SecContext ctx from THostAuth listed in fgAuthInfo.

Private Attributes
TString	fDetails

THostAuth *	fHostAuth

TString	fPasswd

TString	fProtocol

Bool_t	fPwHash

TString	fRemote

Int_t	fRSAKey

TRootSecContext *	fSecContext

ESecurity	fSecurity

TSocket *	fSocket

Int_t	fTimeOut

TString	fUser

Int_t	fVersion

Static Private Attributes
static TList *	fgAuthInfo = 0

static TString	fgAuthMeth [kMAXSEC]

static Bool_t	fgAuthReUse

static Int_t	fgAuthTO = -2

static TString	fgDefaultUser

static TDatime	fgExpDate

static GlobusAuth_t	fgGlobusAuthHook

static Krb5Auth_t	fgKrb5AuthHook

static TString	fgKrb5Principal

static TDatime	fgLastAuthrc

static Int_t	fgLastError = -1

static TString	fgPasswd

static TPluginHandler *	fgPasswdDialog = (TPluginHandler *)(-1)

static Int_t	fgProcessID = -1

static Bool_t	fgPromptUser

static Bool_t	fgPwHash

static Bool_t	fgReadHomeAuthrc = kTRUE

static TString	fgRootAuthrc

static Int_t	fgRSAInit = 0

static Int_t	fgRSAKey = -1

static R__rsa_KEY	fgRSAPriKey

static R__rsa_KEY_export *	fgRSAPubExport = R__fgRSAPubExport

static R__rsa_KEY	fgRSAPubKey

static SecureAuth_t	fgSecAuthHook

static TString	fgUser

static Bool_t	fgUsrPwdCrypt

Friends
class	TRootAuth

class	TRootSecContext

class	TSocket

Additional Inherited Members
Protected Types inherited from TObject
enum	{ kOnlyPrepStep = (1ULL << ( 3 )) }

Protected Member Functions inherited from TObject
virtual void	DoError (int level, const char location, const char fmt, va_list va) const
	Interface to ErrorHandler (protected).

void	MakeZombie ()

Static Protected Member Functions inherited from TObject
static void	SavePrimitiveConstructor (std::ostream &out, TClass cl, const char variable_name, const char *constructor_agrs="", Bool_t empty_line=kTRUE)
	Save object constructor in the output stream "out".

static void	SavePrimitiveDraw (std::ostream &out, const char variable_name, Option_t option=nullptr)
	Save invocation of primitive Draw() method Skipped if option contains "nodraw" string.

static TString	SavePrimitiveVector (std::ostream &out, const char prefix, Int_t len, Double_t arr, Bool_t empty_line=kFALSE)
	Save array in the output stream "out" as vector.

#include <TAuthenticate.h>

Inheritance diagram for TAuthenticate:

[legend]

Member Enumeration Documentation

◆ ESecurity

enum TAuthenticate::ESecurity

Enumerator
kClear
kUnsupported
kKrb5
kGlobus
kSSH
kRfio

Definition at line 59 of file TAuthenticate.h.

Constructor & Destructor Documentation

◆ TAuthenticate()

TAuthenticate::TAuthenticate	(	TSocket *	sock,
		const char *	remote,
		const char *	proto,
		const char *	user = "" )

Create authentication object.

Definition at line 161 of file TAuthenticate.cxx.

◆ ~TAuthenticate()

virtual TAuthenticate::~TAuthenticate ( )

inlinevirtual

Definition at line 127 of file TAuthenticate.h.

Member Function Documentation

◆ Authenticate()

Bool_t TAuthenticate::Authenticate ( )

Authenticate to remote rootd server.

Return kTRUE if authentication succeeded.

Definition at line 347 of file TAuthenticate.cxx.

◆ AuthError()

void TAuthenticate::AuthError	(	const char *	where,
		Int_t	error )

static

Print error string depending on error code.

Definition at line 1219 of file TAuthenticate.cxx.

◆ AuthExists()

Int_t TAuthenticate::AuthExists	(	TString	username,
		Int_t	method,
		const char *	options,
		Int_t *	message,
		Int_t *	rflag,
		CheckSecCtx_t	checksecctx )

Check if we have a valid established sec context in memory Retrieves relevant info and negotiates with server.

options = "Opt,strlen(username),username.Data()" message = kROOTD_USER, ...

Definition at line 2179 of file TAuthenticate.cxx.

◆ CatchTimeOut()

void TAuthenticate::CatchTimeOut ( )

Called in connection with a timer timeout.

Definition at line 331 of file TAuthenticate.cxx.

◆ CheckHost()

Bool_t TAuthenticate::CheckHost	(	const char *	Host,
		const char *	host )

staticprivate

Check if 'host' matches 'href': this means either equal or "containing" it, even with wild cards * in the first field (in the case 'href' is a name, ie not IP address) Returns kTRUE if the two matches.

Definition at line 1388 of file TAuthenticate.cxx.

◆ CheckNetrc() [1/2]

Bool_t TAuthenticate::CheckNetrc	(	TString &	user,
		TString &	passwd )

Try to get user name and passwd from the ~/.rootnetrc or ~/.netrc files.

For more info see the version with 4 arguments. This version is maintained for backward compatability reasons.

Definition at line 849 of file TAuthenticate.cxx.

◆ CheckNetrc() [2/2]

Bool_t TAuthenticate::CheckNetrc	(	TString &	user,
		TString &	passwd,
		Bool_t &	pwhash,
		Bool_t	srppwd )

Try to get user name and passwd from the ~/.rootnetrc or ~/.netrc files.

First ~/.rootnetrc is tried, after that ~/.netrc. These files will only be used when their access masks are 0600. Returns kTRUE if user and passwd were found for the machine specified in the URL. If kFALSE, user and passwd are "". The boolean pwhash is set to kTRUE if the returned passwd is to be understood as password hash, i.e. if the 'password-hash' keyword is found in the 'machine' lines; not implemented for 'secure' and the .netrc file. The format of these files are:

this is a comment line

machine <machine fqdn> login <user> password <passwd> machine <machine fqdn> login <user> password-hash <passwd>

and in addition ~/.rootnetrc also supports:

secure <machine fqdn> login <user> password <passwd>

<machine fqdn> may be a domain name or contain the wild card '*'.

for the secure protocols. All lines must start in the first column.

Definition at line 879 of file TAuthenticate.cxx.

◆ Class()

static TClass * TAuthenticate::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * TAuthenticate::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t TAuthenticate::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 200 of file TAuthenticate.h.

◆ ClearAuth()

Int_t TAuthenticate::ClearAuth	(	TString &	user,
		TString &	passwd,
		Bool_t &	pwdhash )

private

UsrPwd client authentication code.

Returns 0 in case authentication failed 1 in case of success

Definition at line 1457 of file TAuthenticate.cxx.

◆ DeclFileName()

static const char * TAuthenticate::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 200 of file TAuthenticate.h.

◆ DecodeRSAPublic()

Int_t TAuthenticate::DecodeRSAPublic	(	const char *	rsapubexport,
		R__rsa_NUMBER &	n,
		R__rsa_NUMBER &	d,
		char **	rsassl = nullptr )

static

Store RSA public keys from export string rsaPubExport.

Definition at line 2836 of file TAuthenticate.cxx.

◆ FileExpand()

void TAuthenticate::FileExpand	(	const char *	fexp,
		FILE *	ftmp )

staticprivate

Expands include directives found in fexp files The expanded, temporary file, is pointed to by 'ftmp' and should be already open.

To be called recursively.

Definition at line 2021 of file TAuthenticate.cxx.

◆ GenRSAKeys()

Int_t TAuthenticate::GenRSAKeys ( )

private

Generate a valid pair of private/public RSA keys to protect for authentication token exchange.

Definition at line 2401 of file TAuthenticate.cxx.

◆ GetAuthInfo()

TList * TAuthenticate::GetAuthInfo ( )

static

Static method returning the list with authentication details.

Definition at line 1207 of file TAuthenticate.cxx.

◆ GetAuthMethod()

const char * TAuthenticate::GetAuthMethod ( Int_t idx )

static

Static method returning the method corresponding to idx.

Definition at line 1038 of file TAuthenticate.cxx.

◆ GetAuthMethodIdx()

Int_t TAuthenticate::GetAuthMethodIdx ( const char * meth )

static

Static method returning the method index (which can be used to find the method in GetAuthMethod()).

Returns -1 in case meth is not found.

Definition at line 1053 of file TAuthenticate.cxx.

◆ GetAuthReUse()

Bool_t TAuthenticate::GetAuthReUse ( )

static

Static method returning the authentication reuse settings.

Definition at line 1022 of file TAuthenticate.cxx.

◆ GetClientProtocol()

Int_t TAuthenticate::GetClientProtocol ( )

static

Static method returning supported client protocol.

Definition at line 3425 of file TAuthenticate.cxx.

◆ GetDefaultDetails()

char * TAuthenticate::GetDefaultDetails	(	Int_t	method,
		Int_t	opt,
		const char *	usr )

static

Determine default authentication details for method 'sec' and user 'usr'.

Checks .rootrc family files. Returned string must be deleted by the user.

Definition at line 2100 of file TAuthenticate.cxx.

◆ GetDefaultUser()

const char * TAuthenticate::GetDefaultUser ( )

static

Static method returning the default user information.

Definition at line 1005 of file TAuthenticate.cxx.

◆ GetGlobalExpDate()

TDatime TAuthenticate::GetGlobalExpDate ( )

static

Static method returning default expiring date for new validity contexts.

Definition at line 997 of file TAuthenticate.cxx.

◆ GetGlobalPwHash()

Bool_t TAuthenticate::GetGlobalPwHash ( )

static

Static method returning the global password hash flag.

Definition at line 981 of file TAuthenticate.cxx.

◆ GetGlobalSRPPwd()

Bool_t TAuthenticate::GetGlobalSRPPwd ( )

static

Static method returning the global SRP password flag.

Definition at line 989 of file TAuthenticate.cxx.

◆ GetGlobalUser()

const char * TAuthenticate::GetGlobalUser ( )

static

Static method returning the global user.

Definition at line 973 of file TAuthenticate.cxx.

◆ GetGlobusAuthHook()

GlobusAuth_t TAuthenticate::GetGlobusAuthHook ( )

static

Static method returning the globus authorization hook (no longer supported)

Definition at line 1165 of file TAuthenticate.cxx.

◆ GetHostAuth() [1/2]

THostAuth * TAuthenticate::GetHostAuth ( ) const

inline

Definition at line 136 of file TAuthenticate.h.

◆ GetHostAuth() [2/2]

THostAuth * TAuthenticate::GetHostAuth	(	const char *	host,
		const char *	user = "",
		Option_t *	opt = "R",
		Int_t *	exact = nullptr )

static

Sets fUser=user and search fgAuthInfo for the entry pertaining to (host,user), setting fHostAuth accordingly.

If no entry is found fHostAuth is not changed

Definition at line 1909 of file TAuthenticate.cxx.

◆ GetKrb5Principal()

const char * TAuthenticate::GetKrb5Principal ( )

static

Static method returning the principal to be used to init Krb5 tickets.

Definition at line 1013 of file TAuthenticate.cxx.

◆ GetPromptUser()

Bool_t TAuthenticate::GetPromptUser ( )

static

Static method returning the prompt user settings.

Definition at line 1030 of file TAuthenticate.cxx.

◆ GetProtocol()

const char * TAuthenticate::GetProtocol ( ) const

inline

Definition at line 137 of file TAuthenticate.h.

◆ GetPwHash()

Bool_t TAuthenticate::GetPwHash ( ) const

inlineprivate

Definition at line 77 of file TAuthenticate.h.

◆ GetRandString()

char * TAuthenticate::GetRandString	(	Int_t	opt,
		Int_t	len )

private

Allocates and fills a 0 terminated buffer of length len+1 with len random characters.

Returns pointer to the buffer (to be deleted by the caller) opt = 0 any non dangerous char 1 letters and numbers (upper and lower case) 2 hex characters (upper and lower case)

Definition at line 2645 of file TAuthenticate.cxx.

◆ GetRemoteHost()

const char * TAuthenticate::GetRemoteHost ( ) const

inline

Definition at line 138 of file TAuthenticate.h.

◆ GetRSAInit()

Int_t TAuthenticate::GetRSAInit ( )

static

Static method returning the RSA initialization flag.

Definition at line 1182 of file TAuthenticate.cxx.

◆ GetRSAKey()

Int_t TAuthenticate::GetRSAKey ( ) const

inlineprivate

Definition at line 78 of file TAuthenticate.h.

◆ GetRSAKeyType()

Int_t TAuthenticate::GetRSAKeyType ( ) const

inline

Definition at line 139 of file TAuthenticate.h.

◆ GetRSAPubExport()

const char * TAuthenticate::GetRSAPubExport ( Int_t key = 0 )

static

Static method returning the RSA public keys.

Definition at line 1173 of file TAuthenticate.cxx.

◆ GetSecContext()

TRootSecContext * TAuthenticate::GetSecContext ( ) const

inline

Definition at line 140 of file TAuthenticate.h.

◆ GetSecurity()

ESecurity TAuthenticate::GetSecurity ( ) const

inlineprivate

Definition at line 79 of file TAuthenticate.h.

◆ GetSocket()

TSocket * TAuthenticate::GetSocket ( ) const

inline

Definition at line 141 of file TAuthenticate.h.

◆ GetSRPPwd()

Bool_t TAuthenticate::GetSRPPwd ( ) const

inlineprivate

Definition at line 80 of file TAuthenticate.h.

◆ GetSshUser()

const char * TAuthenticate::GetSshUser ( TString user ) const

private

Method returning the user to be used for the ssh login (no longer supported)

Definition at line 1376 of file TAuthenticate.cxx.

◆ GetUser()

const char * TAuthenticate::GetUser ( ) const

inline

Definition at line 142 of file TAuthenticate.h.

◆ GetUserPasswd()

Bool_t TAuthenticate::GetUserPasswd	(	TString &	user,
		TString &	passwd,
		Bool_t &	pwhash,
		Bool_t	srppwd )

private

Try to get user name and passwd from several sources.

Definition at line 781 of file TAuthenticate.cxx.

◆ GetVersion()

Int_t TAuthenticate::GetVersion ( ) const

inlineprivate

Definition at line 82 of file TAuthenticate.h.

◆ HasHostAuth()

THostAuth * TAuthenticate::HasHostAuth	(	const char *	host,
		const char *	user,
		Option_t *	opt = "R" )

static

Checks if a THostAuth with exact match for {host,user} exists in the fgAuthInfo list Returns pointer to it or 0.

Definition at line 1981 of file TAuthenticate.cxx.

◆ HasTimedOut()

Int_t TAuthenticate::HasTimedOut ( ) const

inline

Definition at line 143 of file TAuthenticate.h.

◆ InitRandom()

void TAuthenticate::InitRandom ( )

static

Initialize random machine using seed from /dev/urandom (or current time if /dev/urandom not available).

Definition at line 2373 of file TAuthenticate.cxx.

◆ IsA()

TClass * TAuthenticate::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from TObject.

Definition at line 200 of file TAuthenticate.h.

◆ MergeHostAuthList()

void TAuthenticate::MergeHostAuthList	(	TList *	std,
		TList *	nin,
		Option_t *	opt = "" )

static

Tool for updating fgAuthInfo 'nin' contains list of last input information through (re)reading of a rootauthrc-alike file.

'nin' info has priority. 'std' is cleaned from inactive members. 'nin' members used to update existing members in 'std' are removed from 'nin', do that they do not leak

Definition at line 3354 of file TAuthenticate.cxx.

◆ PromptPasswd()

char * TAuthenticate::PromptPasswd ( const char * prompt = "Password: " )

static

Static method to prompt for the user's passwd to be used for authentication to rootd.

Uses non-echoing command line to get passwd. Returns passwd (which must de deleted by caller) or 0. If non-interactive run returns -1

Definition at line 1113 of file TAuthenticate.cxx.

◆ PromptUser()

char * TAuthenticate::PromptUser ( const char * remote )

static

Static method to prompt for the user name to be used for authentication to rootd.

User is asked to type user name. Returns user name (which must be deleted by caller) or 0. If non-interactive run returns default user.

Definition at line 1073 of file TAuthenticate.cxx.

◆ ReadRootAuthrc()

Int_t TAuthenticate::ReadRootAuthrc ( )

static

Read authentication directives from $ROOTAUTHRC, $HOME/.rootauthrc or <Root_etc_dir>/system.rootauthrc and create related THostAuth objects.

Files are read only if they changed since last reading

Definition at line 3111 of file TAuthenticate.cxx.

◆ RemoveHostAuth()

void TAuthenticate::RemoveHostAuth	(	THostAuth *	ha,
		Option_t *	opt = "" )

static

Remove THostAuth instance from the list.

Definition at line 2131 of file TAuthenticate.cxx.

◆ RemoveSecContext()

void TAuthenticate::RemoveSecContext ( TRootSecContext * ctx )

staticprivate

Tool for removing SecContext ctx from THostAuth listed in fgAuthInfo.

Definition at line 3404 of file TAuthenticate.cxx.

◆ RfioAuth()

Int_t TAuthenticate::RfioAuth ( TString & user )

private

RFIO authentication (no longer supported)

Definition at line 1446 of file TAuthenticate.cxx.

◆ SecureRecv()

Int_t TAuthenticate::SecureRecv	(	TSocket *	sock,
		Int_t	dec,
		Int_t	key,
		char **	str )

static

Receive str from sock and decode it using key indicated by key type Return number of received bytes or -1 in case of error.

dec = 1 for private decoding, dec = 2 for public decoding

Definition at line 2764 of file TAuthenticate.cxx.

◆ SecureSend()

Int_t TAuthenticate::SecureSend	(	TSocket *	sock,
		Int_t	enc,
		Int_t	key,
		const char *	str )

static

Encode null terminated str using the session private key indicated by enc and sends it over the network Returns number of bytes sent, or -1 in case of error.

enc = 1 for private encoding, enc = 2 for public encoding

Definition at line 2703 of file TAuthenticate.cxx.

◆ SendRSAPublicKey()

Int_t TAuthenticate::SendRSAPublicKey	(	TSocket *	Socket,
		Int_t	key = 0 )

static

Receives server RSA Public key Sends local RSA public key encoded.

Definition at line 3017 of file TAuthenticate.cxx.

◆ SetAuthReUse()

void TAuthenticate::SetAuthReUse ( Bool_t authreuse )

static

Set global AuthReUse flag.

Definition at line 1325 of file TAuthenticate.cxx.

◆ SetDefaultRSAKeyType()

void TAuthenticate::SetDefaultRSAKeyType ( Int_t key )

static

Static method setting the default type of RSA key.

Definition at line 1190 of file TAuthenticate.cxx.

◆ SetDefaultUser()

void TAuthenticate::SetDefaultUser ( const char * defaultuser )

static

Set default user name.

Definition at line 1305 of file TAuthenticate.cxx.

◆ SetEnvironment()

void TAuthenticate::SetEnvironment ( )

private

Set default authentication environment.

The values are inferred from fSecurity and fDetails.

Definition at line 659 of file TAuthenticate.cxx.

◆ SetGlobalExpDate()

void TAuthenticate::SetGlobalExpDate ( TDatime expdate )

static

Set default expiring date for new validity contexts.

Definition at line 1297 of file TAuthenticate.cxx.

◆ SetGlobalPasswd()

void TAuthenticate::SetGlobalPasswd ( const char * passwd )

static

Set global passwd to be used for authentication to rootd.

Definition at line 1267 of file TAuthenticate.cxx.

◆ SetGlobalPwHash()

void TAuthenticate::SetGlobalPwHash ( Bool_t pwhash )

static

Set global passwd hash flag to be used for authentication to rootd.

Definition at line 1281 of file TAuthenticate.cxx.

◆ SetGlobalSRPPwd()

void TAuthenticate::SetGlobalSRPPwd ( Bool_t srppwd )

static

Set global SRP passwd flag to be used for authentication to rootd.

Definition at line 1289 of file TAuthenticate.cxx.

◆ SetGlobalUser()

void TAuthenticate::SetGlobalUser ( const char * user )

static

Set global user name to be used for authentication to rootd.

Definition at line 1253 of file TAuthenticate.cxx.

◆ SetGlobusAuthHook()

void TAuthenticate::SetGlobusAuthHook ( GlobusAuth_t func )

static

Set Globus authorization function.

Automatically called when libGlobusAuth is loaded.

Definition at line 1359 of file TAuthenticate.cxx.

◆ SetKrb5AuthHook()

void TAuthenticate::SetKrb5AuthHook ( Krb5Auth_t func )

static

Set kerberos5 authorization function.

Automatically called when libKrb5Auth is loaded.

Definition at line 1350 of file TAuthenticate.cxx.

◆ SetPromptUser()

void TAuthenticate::SetPromptUser ( Bool_t promptuser )

static

Set global PromptUser flag.

Definition at line 1333 of file TAuthenticate.cxx.

◆ SetRSAInit()

void TAuthenticate::SetRSAInit ( Int_t init = 1 )

static

Static method setting RSA initialization flag.

Definition at line 1199 of file TAuthenticate.cxx.

◆ SetRSAKeyType()

void TAuthenticate::SetRSAKeyType ( Int_t key )

inline

Definition at line 144 of file TAuthenticate.h.

◆ SetRSAPublic()

Int_t TAuthenticate::SetRSAPublic	(	const char *	rsaPubExport,
		Int_t	klen )

static

Store RSA public keys from export string rsaPubExport.

Returns type of stored key, or -1 is not recognized

Definition at line 2939 of file TAuthenticate.cxx.

◆ SetSecContext()

void TAuthenticate::SetSecContext ( TRootSecContext * ctx )

inline

Definition at line 145 of file TAuthenticate.h.

◆ SetSecureAuthHook()

void TAuthenticate::SetSecureAuthHook ( SecureAuth_t func )

static

Set secure authorization function.

Definition at line 1341 of file TAuthenticate.cxx.

◆ SetTimeOut()

void TAuthenticate::SetTimeOut ( Int_t to )

static

Set timeout (active if > 0)

Definition at line 1317 of file TAuthenticate.cxx.

◆ Show()

void TAuthenticate::Show ( Option_t * opt = "S" )

static

Print info about the authentication sector.

If 'opt' contains 's' or 'S' prints information about established TSecContext, else prints information about THostAuth

Definition at line 2143 of file TAuthenticate.cxx.

◆ SshAuth()

Int_t TAuthenticate::SshAuth ( TString & user )

private

SSH client authentication code (no longer supported)

Definition at line 1367 of file TAuthenticate.cxx.

◆ SshError()

Int_t TAuthenticate::SshError ( const char * errfile )

private

◆ Streamer()

void TAuthenticate::Streamer ( TBuffer & R__b )

overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void TAuthenticate::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 200 of file TAuthenticate.h.

Friends And Related Symbol Documentation

◆ TRootAuth

friend class TRootAuth

friend

Definition at line 54 of file TAuthenticate.h.

◆ TRootSecContext

friend class TRootSecContext

friend

Definition at line 55 of file TAuthenticate.h.

◆ TSocket

friend class TSocket

friend

Definition at line 56 of file TAuthenticate.h.

Member Data Documentation

◆ fDetails

TString TAuthenticate::fDetails

private

Definition at line 62 of file TAuthenticate.h.

◆ fgAuthInfo

TList * TAuthenticate::fgAuthInfo = 0

staticprivate

Definition at line 92 of file TAuthenticate.h.

◆ fgAuthMeth

TString TAuthenticate::fgAuthMeth

staticprivate

Initial value:

= { "UsrPwd", "Unsupported", "Unsupported",

"Unsupported", "Unsupported", "Unsupported" }

Definition at line 92 of file TAuthenticate.h.

◆ fgAuthReUse

Bool_t TAuthenticate::fgAuthReUse

staticprivate

Definition at line 94 of file TAuthenticate.h.

◆ fgAuthTO

Int_t TAuthenticate::fgAuthTO = -2

staticprivate

Definition at line 116 of file TAuthenticate.h.

◆ fgDefaultUser

TString TAuthenticate::fgDefaultUser

staticprivate

Definition at line 95 of file TAuthenticate.h.

◆ fgExpDate

TDatime TAuthenticate::fgExpDate

staticprivate

Definition at line 96 of file TAuthenticate.h.

◆ fgGlobusAuthHook

GlobusAuth_t TAuthenticate::fgGlobusAuthHook

staticprivate

Definition at line 97 of file TAuthenticate.h.

◆ fgKrb5AuthHook

Krb5Auth_t TAuthenticate::fgKrb5AuthHook

staticprivate

Definition at line 98 of file TAuthenticate.h.

◆ fgKrb5Principal

TString TAuthenticate::fgKrb5Principal

staticprivate

Definition at line 99 of file TAuthenticate.h.

◆ fgLastAuthrc

TDatime TAuthenticate::fgLastAuthrc

staticprivate

Definition at line 100 of file TAuthenticate.h.

◆ fgLastError

Int_t TAuthenticate::fgLastError = -1

staticprivate

Definition at line 115 of file TAuthenticate.h.

◆ fgPasswd

TString TAuthenticate::fgPasswd

staticprivate

Definition at line 101 of file TAuthenticate.h.

◆ fgPasswdDialog

TPluginHandler * TAuthenticate::fgPasswdDialog = (TPluginHandler *)(-1)

staticprivate

Definition at line 102 of file TAuthenticate.h.

◆ fgProcessID

Int_t TAuthenticate::fgProcessID = -1

staticprivate

Definition at line 117 of file TAuthenticate.h.

◆ fgPromptUser

Bool_t TAuthenticate::fgPromptUser

staticprivate

Definition at line 103 of file TAuthenticate.h.

◆ fgPwHash

Bool_t TAuthenticate::fgPwHash

staticprivate

Definition at line 104 of file TAuthenticate.h.

◆ fgReadHomeAuthrc

Bool_t TAuthenticate::fgReadHomeAuthrc = kTRUE

staticprivate

Definition at line 105 of file TAuthenticate.h.

◆ fgRootAuthrc

TString TAuthenticate::fgRootAuthrc

staticprivate

Definition at line 106 of file TAuthenticate.h.

◆ fgRSAInit

Int_t TAuthenticate::fgRSAInit = 0

staticprivate

Definition at line 108 of file TAuthenticate.h.

◆ fgRSAKey

Int_t TAuthenticate::fgRSAKey = -1

staticprivate

Definition at line 107 of file TAuthenticate.h.

◆ fgRSAPriKey

R__rsa_KEY TAuthenticate::fgRSAPriKey

staticprivate

Definition at line 109 of file TAuthenticate.h.

◆ fgRSAPubExport

R__rsa_KEY_export * TAuthenticate::fgRSAPubExport = R__fgRSAPubExport

staticprivate

Definition at line 111 of file TAuthenticate.h.

◆ fgRSAPubKey

R__rsa_KEY TAuthenticate::fgRSAPubKey

staticprivate

Definition at line 110 of file TAuthenticate.h.

◆ fgSecAuthHook

SecureAuth_t TAuthenticate::fgSecAuthHook

staticprivate

Definition at line 112 of file TAuthenticate.h.

◆ fgUser

TString TAuthenticate::fgUser

staticprivate

Definition at line 113 of file TAuthenticate.h.

◆ fgUsrPwdCrypt

Bool_t TAuthenticate::fgUsrPwdCrypt

staticprivate

Definition at line 114 of file TAuthenticate.h.

◆ fHostAuth

THostAuth* TAuthenticate::fHostAuth

private

Definition at line 63 of file TAuthenticate.h.

◆ fPasswd

TString TAuthenticate::fPasswd

private

Definition at line 64 of file TAuthenticate.h.

◆ fProtocol

TString TAuthenticate::fProtocol

private

Definition at line 65 of file TAuthenticate.h.

◆ fPwHash

Bool_t TAuthenticate::fPwHash

private

Definition at line 66 of file TAuthenticate.h.

◆ fRemote

TString TAuthenticate::fRemote

private

Definition at line 67 of file TAuthenticate.h.

◆ fRSAKey

Int_t TAuthenticate::fRSAKey

private

Definition at line 68 of file TAuthenticate.h.

◆ fSecContext

TRootSecContext* TAuthenticate::fSecContext

private

Definition at line 69 of file TAuthenticate.h.

◆ fSecurity

ESecurity TAuthenticate::fSecurity

private

Definition at line 70 of file TAuthenticate.h.

◆ fSocket

TSocket* TAuthenticate::fSocket

private

Definition at line 71 of file TAuthenticate.h.

◆ fTimeOut

Int_t TAuthenticate::fTimeOut

private

Definition at line 74 of file TAuthenticate.h.

◆ fUser

TString TAuthenticate::fUser

private

Definition at line 73 of file TAuthenticate.h.

◆ fVersion

Int_t TAuthenticate::fVersion

private

Definition at line 72 of file TAuthenticate.h.

Libraries for TAuthenticate:

[legend]

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

net/auth/inc/TAuthenticate.h
net/auth/src/TAuthenticate.cxx

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Friends

Additional Inherited Members

Member Enumeration Documentation

◆ ESecurity

Constructor & Destructor Documentation

◆ TAuthenticate()

◆ ~TAuthenticate()

Member Function Documentation

◆ Authenticate()

◆ AuthError()

◆ AuthExists()

◆ CatchTimeOut()

◆ CheckHost()

◆ CheckNetrc() [1/2]

◆ CheckNetrc() [2/2]

this is a comment line

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ ClearAuth()

◆ DeclFileName()

◆ DecodeRSAPublic()

◆ FileExpand()

◆ GenRSAKeys()

◆ GetAuthInfo()

◆ GetAuthMethod()

◆ GetAuthMethodIdx()

◆ GetAuthReUse()

◆ GetClientProtocol()

◆ GetDefaultDetails()

◆ GetDefaultUser()

◆ GetGlobalExpDate()

◆ GetGlobalPwHash()

◆ GetGlobalSRPPwd()

◆ GetGlobalUser()

◆ GetGlobusAuthHook()

◆ GetHostAuth() [1/2]

◆ GetHostAuth() [2/2]

◆ GetKrb5Principal()

◆ GetPromptUser()

◆ GetProtocol()

◆ GetPwHash()

◆ GetRandString()

◆ GetRemoteHost()

◆ GetRSAInit()

◆ GetRSAKey()

◆ GetRSAKeyType()

◆ GetRSAPubExport()

◆ GetSecContext()

◆ GetSecurity()

◆ GetSocket()

◆ GetSRPPwd()

◆ GetSshUser()

◆ GetUser()

◆ GetUserPasswd()

◆ GetVersion()

◆ HasHostAuth()

◆ HasTimedOut()

◆ InitRandom()

◆ IsA()

◆ MergeHostAuthList()

◆ PromptPasswd()

◆ PromptUser()

◆ ReadRootAuthrc()

◆ RemoveHostAuth()

◆ RemoveSecContext()

◆ RfioAuth()

◆ SecureRecv()

◆ SecureSend()

◆ SendRSAPublicKey()

◆ SetAuthReUse()

◆ SetDefaultRSAKeyType()

◆ SetDefaultUser()