Logo ROOT  
Reference Guide
Go to the documentation of this file.
1// @(#)root/auth:$Id$
2// Author: Fons Rademakers 26/11/2000
5 * Copyright (C) 1995-2000, Rene Brun and Fons Rademakers. *
6 * All rights reserved. *
7 * *
8 * For the licensing terms see $ROOTSYS/LICENSE. *
9 * For the list of contributors see $ROOTSYS/README/CREDITS. *
10 *************************************************************************/
12#ifndef ROOT_TAuthenticate
13#define ROOT_TAuthenticate
17// //
18// TAuthenticate //
19// //
20// An authentication module for ROOT based network services, like rootd //
21// and proofd. //
22// //
25#include "TObject.h"
26#include "TString.h"
27#include "TList.h"
28#include "TDatime.h"
29#ifndef ROOT_rsafun
30//#include "rsafun.h"
32#include "AuthConst.h"
34class TAuthenticate;
35class THostAuth;
36class TPluginHandler;
37class TSocket;
38class TRootSecContext;
39class TVirtualMutex;
41typedef Int_t (*CheckSecCtx_t)(const char *subj, TRootSecContext *ctx);
42typedef Int_t (*GlobusAuth_t)(TAuthenticate *auth, TString &user, TString &det);
43typedef Int_t (*Krb5Auth_t)(TAuthenticate *auth, TString &user, TString &det, Int_t version);
44typedef Int_t (*SecureAuth_t)(TAuthenticate *auth, const char *user, const char *passwd,
45 const char *remote, TString &det, Int_t version);
49struct R__rsa_KEY; // opaque replacement for rsa_KEY
50struct R__rsa_KEY_export; // opaque replacement for rsa_KEY_export
51struct R__rsa_NUMBER; // opaque replacement for rsa_NUMBER
53class TAuthenticate : public TObject {
55friend class TRootAuth;
56friend class TRootSecContext;
57friend class TSocket;
60 enum ESecurity { kClear, kUnsupported, kKrb5, kGlobus, kSSH, kRfio }; // type of authentication
63 TString fDetails; // logon details (method dependent ...)
64 THostAuth *fHostAuth; // pointer to relevant authentication info
65 TString fPasswd; // user's password
66 TString fProtocol; // remote service (rootd, proofd)
67 Bool_t fPwHash; // kTRUE if fPasswd is a passwd hash
68 TString fRemote; // remote host to which we want to connect
69 Int_t fRSAKey; // Type of RSA key used
70 TRootSecContext *fSecContext; // pointer to relevant sec context
71 ESecurity fSecurity; // actual logon security level
72 TSocket *fSocket; // connection to remote daemon
73 Int_t fVersion; // 0,1,2, ... accordingly to remote daemon version
74 TString fUser; // user to be authenticated
75 Int_t fTimeOut; // timeout flag
78 Bool_t GetPwHash() const { return fPwHash; }
79 Int_t GetRSAKey() const { return fRSAKey; }
80 ESecurity GetSecurity() const { return fSecurity; }
81 Bool_t GetSRPPwd() const { return false; }
82 const char *GetSshUser(TString user) const;
83 Int_t GetVersion() const { return fVersion; }
84 Int_t ClearAuth(TString &user, TString &passwd, Bool_t &pwhash);
86 Bool_t &pwhash, Bool_t srppwd);
87 char *GetRandString(Int_t Opt,Int_t Len);
89 Int_t RfioAuth(TString &user);
90 void SetEnvironment();
91 Int_t SshAuth(TString &user);
92 Int_t SshError(const char *errfile);
96 static Bool_t fgAuthReUse; // kTRUE is ReUse required
97 static TString fgDefaultUser; // Default user information
98 static TDatime fgExpDate; // Expiring date for new security contexts
101 static TString fgKrb5Principal; // Principal for Krb5 ticket
102 static TDatime fgLastAuthrc; // Time of last reading of fgRootAuthrc
104 static TPluginHandler *fgPasswdDialog; // Passwd dialog GUI plugin
105 static Bool_t fgPromptUser; // kTRUE if user prompt required
106 static TList *fgProofAuthInfo; // Specific lists of THostAuth fro proof
107 static Bool_t fgPwHash; // kTRUE if fgPasswd is a passwd hash
108 static Bool_t fgReadHomeAuthrc; // kTRUE to look for $HOME/.rootauthrc
109 static TString fgRootAuthrc; // Path to last rootauthrc-like file read
110 static Int_t fgRSAKey; // Default type of RSA key to be tried
114 static R__rsa_KEY_export* fgRSAPubExport; // array of size [2]
117 static Bool_t fgUsrPwdCrypt; // kTRUE if encryption for UsrPwd is required
118 static Int_t fgLastError; // Last error code processed by AuthError()
119 static Int_t fgAuthTO; // if > 0, timeout in sec
120 static Int_t fgProcessID; // ID of the main thread as unique identifier
122 static Bool_t CheckHost(const char *Host, const char *host);
124 static void FileExpand(const char *fin, FILE *ftmp);
125 static Int_t ProofAuthSetup(TSocket *sock, Bool_t client);
126 static void RemoveSecContext(TRootSecContext *ctx);
129 TAuthenticate(TSocket *sock, const char *remote, const char *proto,
130 const char *user = "");
131 virtual ~TAuthenticate() {}
134 Int_t AuthExists(TString User, Int_t method, const char *Options,
135 Int_t *Message, Int_t *Rflag, CheckSecCtx_t funcheck);
136 void CatchTimeOut();
139 Bool_t &pwhash, Bool_t srppwd);
140 THostAuth *GetHostAuth() const { return fHostAuth; }
141 const char *GetProtocol() const { return fProtocol; }
142 const char *GetRemoteHost() const { return fRemote; }
143 Int_t GetRSAKeyType() const { return fRSAKey; }
145 TSocket *GetSocket() const { return fSocket; }
146 const char *GetUser() const { return fUser; }
147 Int_t HasTimedOut() const { return fTimeOut; }
148 void SetRSAKeyType(Int_t key) { fRSAKey = key; }
151 static void AuthError(const char *where, Int_t error);
152 static Bool_t CheckProofAuth(Int_t cSec, TString &det);
154 static Int_t DecodeRSAPublic(const char *rsapubexport, R__rsa_NUMBER &n,
155 R__rsa_NUMBER &d, char **rsassl = 0);
157 static TList *GetAuthInfo();
158 static const char *GetAuthMethod(Int_t idx);
159 static Int_t GetAuthMethodIdx(const char *meth);
160 static Bool_t GetAuthReUse();
161 static Int_t GetClientProtocol();
162 static char *GetDefaultDetails(Int_t method, Int_t opt, const char *user);
163 static const char *GetDefaultUser();
164 static TDatime GetGlobalExpDate();
165 static Bool_t GetGlobalPwHash();
166 static Bool_t GetGlobalSRPPwd();
167 static const char *GetGlobalUser();
169 static THostAuth *GetHostAuth(const char *host, const char *user="",
170 Option_t *opt = "R", Int_t *Exact = 0);
171 static const char *GetKrb5Principal();
172 static Bool_t GetPromptUser();
173 static TList *GetProofAuthInfo();
174 static Int_t GetRSAInit();
175 static const char *GetRSAPubExport(Int_t key = 0);
176 static THostAuth *HasHostAuth(const char *host, const char *user,
177 Option_t *opt = "R");
178 static void InitRandom();
179 static void MergeHostAuthList(TList *Std, TList *New, Option_t *Opt = "");
180 static char *PromptPasswd(const char *prompt = "Password: ");
181 static char *PromptUser(const char *remote);
182 static Int_t ReadRootAuthrc();
183 static void RemoveHostAuth(THostAuth *ha, Option_t *opt = "");
184 static Int_t SecureRecv(TSocket *Socket, Int_t dec,
185 Int_t KeyType, char **Out);
186 static Int_t SecureSend(TSocket *Socket, Int_t enc,
187 Int_t KeyType, const char *In);
188 static Int_t SendRSAPublicKey(TSocket *Socket, Int_t key = 0);
189 static void SetAuthReUse(Bool_t authreuse);
190 static void SetDefaultUser(const char *defaultuser);
191 static void SetGlobalExpDate(TDatime expdate);
192 static void SetGlobalPasswd(const char *passwd);
193 static void SetGlobalPwHash(Bool_t pwhash);
194 static void SetGlobalSRPPwd(Bool_t srppwd);
195 static void SetGlobalUser(const char *user);
196 static void SetGlobusAuthHook(GlobusAuth_t func);
197 static void SetKrb5AuthHook(Krb5Auth_t func);
198 static void SetPromptUser(Bool_t promptuser);
199 static void SetDefaultRSAKeyType(Int_t key);
200 static void SetReadHomeAuthrc(Bool_t readhomeauthrc); // for PROOF
201 static void SetRSAInit(Int_t init = 1);
202 static Int_t SetRSAPublic(const char *rsapubexport, Int_t klen);
203 static void SetSecureAuthHook(SecureAuth_t func);
204 static void SetTimeOut(Int_t to);
205 static void Show(Option_t *opt="S");
207 ClassDefOverride(TAuthenticate,0) // Class providing remote authentication service
const Int_t kMAXSEC
Definition: AuthConst.h:26
#define R__EXTERN
Definition: DllImport.h:27
#define d(i)
Definition: RSha256.hxx:102
bool Bool_t
Definition: RtypesCore.h:63
int Int_t
Definition: RtypesCore.h:45
const char Option_t
Definition: RtypesCore.h:66
#define ClassDefOverride(name, id)
Definition: Rtypes.h:339
std::string Message(const std::string &msg, const std::string &location)
Definition: Scanner.cxx:178
R__EXTERN TVirtualMutex * gAuthenticateMutex
Definition: TAuthenticate.h:47
Int_t(* Krb5Auth_t)(TAuthenticate *auth, TString &user, TString &det, Int_t version)
Definition: TAuthenticate.h:43
Int_t(* SecureAuth_t)(TAuthenticate *auth, const char *user, const char *passwd, const char *remote, TString &det, Int_t version)
Definition: TAuthenticate.h:44
Int_t(* GlobusAuth_t)(TAuthenticate *auth, TString &user, TString &det)
Definition: TAuthenticate.h:42
Int_t(* CheckSecCtx_t)(const char *subj, TRootSecContext *ctx)
Definition: TAuthenticate.h:41
const char * proto
Definition: civetweb.c:17493
virtual ~TAuthenticate()
static void RemoveHostAuth(THostAuth *ha, Option_t *opt="")
Remove THostAuth instance from the list.
static Int_t SetRSAPublic(const char *rsapubexport, Int_t klen)
Store RSA public keys from export string rsaPubExport.
static TPluginHandler * fgPasswdDialog
void SetRSAKeyType(Int_t key)
static Int_t fgProcessID
Bool_t GetPwHash() const
Definition: TAuthenticate.h:78
static void SetGlobalSRPPwd(Bool_t srppwd)
Set global SRP passwd flag to be used for authentication to rootd or proofd.
static Bool_t fgPromptUser
TRootSecContext * fSecContext
Definition: TAuthenticate.h:70
static Bool_t fgPwHash
ESecurity fSecurity
Definition: TAuthenticate.h:71
TRootSecContext * GetSecContext() const
THostAuth * fHostAuth
Definition: TAuthenticate.h:64
static void FileExpand(const char *fin, FILE *ftmp)
Expands include directives found in fexp files The expanded, temporary file, is pointed to by 'ftmp' ...
const char * GetProtocol() const
static TString fgUser
TSocket * fSocket
Definition: TAuthenticate.h:72
static const char * GetGlobalUser()
Static method returning the global user.
static void SetGlobalUser(const char *user)
Set global user name to be used for authentication to rootd or proofd.
static void SetPromptUser(Bool_t promptuser)
Set global PromptUser flag.
Int_t RfioAuth(TString &user)
RFIO authentication (no longer supported)
Int_t HasTimedOut() const
static void Show(Option_t *opt="S")
Print info about the authentication sector.
const char * GetSshUser(TString user) const
Method returning the user to be used for the ssh login (no longer supported)
void SetSecContext(TRootSecContext *ctx)
static const char * GetDefaultUser()
Static method returning the default user information.
static Bool_t GetPromptUser()
Static method returning the prompt user settings.
const char * GetRemoteHost() const
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 o...
static const char * GetKrb5Principal()
Static method returning the principal to be used to init Krb5 tickets.
TSocket * GetSocket() const
THostAuth * GetHostAuth() const
static GlobusAuth_t fgGlobusAuthHook
Definition: TAuthenticate.h:99
static void SetAuthReUse(Bool_t authreuse)
Set global AuthReUse flag.
static R__rsa_KEY_export * fgRSAPubExport
static Int_t fgRSAInit
char * GetRandString(Int_t Opt, Int_t Len)
Allocates and fills a 0 terminated buffer of length len+1 with len random characters.
static TList * GetProofAuthInfo()
Static method returning the list with authentication directives to be sent to proof.
Int_t SshAuth(TString &user)
SSH client authentication code (no longer supported)
ESecurity GetSecurity() const
Definition: TAuthenticate.h:80
static char * PromptPasswd(const char *prompt="Password: ")
Static method to prompt for the user's passwd to be used for authentication to rootd or proofd.
static void SetDefaultUser(const char *defaultuser)
Set default user name.
Int_t GetVersion() const
Definition: TAuthenticate.h:83
static void SetGlobalPwHash(Bool_t pwhash)
Set global passwd hash flag to be used for authentication to rootd or proofd.
static void SetGlobalExpDate(TDatime expdate)
Set default expiring date for new validity contexts.
static Int_t GetRSAInit()
Static method returning the RSA initialization flag.
static void SetSecureAuthHook(SecureAuth_t func)
Set secure authorization function.
static Int_t GetClientProtocol()
Static method returning supported client protocol.
static Int_t ReadRootAuthrc()
Read authentication directives from $ROOTAUTHRC, $HOME/.rootauthrc or <Root_etc_dir>/system....
static Bool_t fgReadHomeAuthrc
static Int_t fgAuthTO
static Int_t fgLastError
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 netwo...
Int_t GenRSAKeys()
Generate a valid pair of private/public RSA keys to protect for authentication token exchange.
Bool_t CheckNetrc(TString &user, TString &passwd)
Try to get user name and passwd from the ~/.rootnetrc or ~/.netrc files.
static TString fgKrb5Principal
static const char * GetRSAPubExport(Int_t key=0)
Static method returning the RSA public keys.
TString fDetails
Definition: TAuthenticate.h:63
static Int_t DecodeRSAPublic(const char *rsapubexport, R__rsa_NUMBER &n, R__rsa_NUMBER &d, char **rsassl=0)
Store RSA public keys from export string rsaPubExport.
static void SetReadHomeAuthrc(Bool_t readhomeauthrc)
Set flag controlling the reading of $HOME/.rootauthrc.
static void InitRandom()
Initialize random machine using seed from /dev/urandom (or current time if /dev/urandom not available...
static TList * fgProofAuthInfo
static R__rsa_KEY fgRSAPubKey
static Bool_t fgAuthReUse
Definition: TAuthenticate.h:96
static Bool_t GetGlobalPwHash()
Static method returning the global password hash flag.
static void SetKrb5AuthHook(Krb5Auth_t func)
Set kerberos5 authorization function.
static void SetGlobusAuthHook(GlobusAuth_t func)
Set Globus authorization function.
static void SetRSAInit(Int_t init=1)
Static method setting RSA initialization flag.
static void SetGlobalPasswd(const char *passwd)
Set global passwd to be used for authentication to rootd or proofd.
static TDatime fgExpDate
Definition: TAuthenticate.h:98
TString fProtocol
Definition: TAuthenticate.h:66
void SetEnvironment()
Set default authentication environment.
const char * GetUser() const
static Int_t SendRSAPublicKey(TSocket *Socket, Int_t key=0)
Receives server RSA Public key Sends local RSA public key encoded.
static Bool_t CheckProofAuth(Int_t cSec, TString &det)
Check if the authentication method can be attempted for the client.
static TDatime fgLastAuthrc
static TList * fgAuthInfo
Definition: TAuthenticate.h:94
static TString fgPasswd
TString fPasswd
Definition: TAuthenticate.h:65
static TString fgAuthMeth[kMAXSEC]
Definition: TAuthenticate.h:95
void CatchTimeOut()
Called in connection with a timer timeout.
Int_t GetRSAKeyType() const
Bool_t GetUserPasswd(TString &user, TString &passwd, Bool_t &pwhash, Bool_t srppwd)
Try to get user name and passwd from several sources.
Bool_t Authenticate()
Authenticate to remote rootd or proofd server.
static R__rsa_KEY fgRSAPriKey
static TString fgRootAuthrc
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 wit...
static TList * GetAuthInfo()
Static method returning the list with authentication details.
static GlobusAuth_t GetGlobusAuthHook()
Static method returning the globus authorization hook (no longer supported)
Int_t ProofAuthSetup()
Authentication related stuff setup in TProofServ.
Int_t ClearAuth(TString &user, TString &passwd, Bool_t &pwhash)
UsrPwd client authentication code.
static void AuthError(const char *where, Int_t error)
Print error string depending on error code.
static Krb5Auth_t fgKrb5AuthHook
static char * GetDefaultDetails(Int_t method, Int_t opt, const char *user)
Determine default authentication details for method 'sec' and user 'usr'.
static void MergeHostAuthList(TList *Std, TList *New, Option_t *Opt="")
Tool for updating fgAuthInfo or fgProofAuthInfo 'nin' contains list of last input information through...
static TString fgDefaultUser
Definition: TAuthenticate.h:97
static Int_t GetAuthMethodIdx(const char *meth)
Static method returning the method index (which can be used to find the method in GetAuthMethod()).
static Int_t fgRSAKey
TString fRemote
Definition: TAuthenticate.h:68
static void SetTimeOut(Int_t to)
Set timeout (active if > 0)
static Bool_t fgUsrPwdCrypt
TAuthenticate(TSocket *sock, const char *remote, const char *proto, const char *user="")
Create authentication object.
static void RemoveSecContext(TRootSecContext *ctx)
Tool for removing SecContext ctx from THostAuth listed in fgAuthInfo or fgProofAuthInfo.
static TDatime GetGlobalExpDate()
Static method returning default expiring date for new validity contexts.
static Bool_t GetGlobalSRPPwd()
Static method returning the global SRP password flag.
static SecureAuth_t fgSecAuthHook
static char * PromptUser(const char *remote)
Static method to prompt for the user name to be used for authentication to rootd or proofd.
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...
Int_t GetRSAKey() const
Definition: TAuthenticate.h:79
Int_t SshError(const char *errfile)
static void SetDefaultRSAKeyType(Int_t key)
Static method setting the default type of RSA key.
static const char * GetAuthMethod(Int_t idx)
Static method returning the method corresponding to idx.
static Bool_t GetAuthReUse()
Static method returning the authentication reuse settings.
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 If opt = "P" use...
Bool_t GetSRPPwd() const
Definition: TAuthenticate.h:81
This class stores the date and time with a precision of one second in an unsigned 32 bit word (950130...
Definition: TDatime.h:37
A doubly linked list.
Definition: TList.h:38
Mother of all ROOT objects.
Definition: TObject.h:37
Basic string class.
Definition: TString.h:136
This class implements a mutex interface.
Definition: TVirtualMutex.h:32
const Int_t n
Definition: legend1.C:16
void init()
Inspect hardware capabilities, and load the optimal library for RooFit computations.