1 #include "opensrf/osrf_app_session.h"
2 #include "opensrf/osrf_application.h"
3 #include "opensrf/osrf_settings.h"
4 #include "opensrf/osrf_json.h"
5 #include "opensrf/log.h"
6 #include "openils/oils_utils.h"
7 #include "openils/oils_constants.h"
8 #include "openils/oils_event.h"
10 #define OILS_AUTH_CACHE_PRFX "oils_auth_"
12 #define MODULENAME "open-ils.auth"
14 #define OILS_AUTH_OPAC "opac"
15 #define OILS_AUTH_STAFF "staff"
16 #define OILS_AUTH_TEMP "temp"
18 int osrfAppInitialize();
19 int osrfAppChildInit();
21 static int _oilsAuthOPACTimeout = 0;
22 static int _oilsAuthStaffTimeout = 0;
23 static int _oilsAuthOverrideTimeout = 0;
26 int osrfAppInitialize() {
28 osrfLogInfo(OSRF_LOG_MARK, "Initializing Auth Server...");
30 /* load and parse the IDL */
31 if (!oilsInitIDL(NULL)) return 1; /* return non-zero to indicate error */
33 osrfAppRegisterMethod(
35 "open-ils.auth.authenticate.init",
37 "Start the authentication process and returns the intermediate authentication seed"
38 " PARAMS( username )", 1, 0 );
40 osrfAppRegisterMethod(
42 "open-ils.auth.authenticate.complete",
44 "Completes the authentication process. Returns an object like so: "
45 "{authtoken : <token>, authtime:<time>}, where authtoken is the login "
46 "token and authtime is the number of seconds the session will be active"
47 "PARAMS(username, md5sum( seed + password ), type, org_id ) "
48 "type can be one of 'opac','staff', or 'temp' and it defaults to 'staff' "
49 "org_id is the location at which the login should be considered "
50 "active for login timeout purposes" , 1, 0 );
52 osrfAppRegisterMethod(
54 "open-ils.auth.session.retrieve",
55 "oilsAuthSessionRetrieve",
56 "Pass in the auth token and this retrieves the user object. The auth "
57 "timeout is reset when this call is made "
58 "Returns the user object (password blanked) for the given login session "
59 "PARAMS( authToken )", 1, 0 );
61 osrfAppRegisterMethod(
63 "open-ils.auth.session.delete",
64 "oilsAuthSessionDelete",
65 "Destroys the given login session "
66 "PARAMS( authToken )", 1, 0 );
68 osrfAppRegisterMethod(
70 "open-ils.auth.session.reset_timeout",
71 "oilsAuthResetTimeout",
72 "Resets the login timeout for the given session "
73 "Returns an ILS Event with payload = session_timeout of session "
74 "if found, otherwise returns the NO_SESSION event"
75 "PARAMS( authToken )", 1, 0 );
80 int osrfAppChildInit() {
84 int oilsAuthInit( osrfMethodContext* ctx ) {
85 OSRF_METHOD_VERIFY_CONTEXT(ctx);
89 char* username = NULL;
94 if( (username = jsonObjectToSimpleString(jsonObjectGetIndex(ctx->params, 0))) ) {
96 if( strchr( username, ' ' ) ) {
98 /* spaces are not allowed */
99 resp = jsonNewObject("x"); /* 'x' will never be a valid seed */
100 osrfAppRespondComplete( ctx, resp );
104 seed = va_list_to_string( "%d.%ld.%s", time(NULL), (long) getpid(), username );
105 key = va_list_to_string( "%s%s", OILS_AUTH_CACHE_PRFX, username );
107 md5seed = md5sum(seed);
108 osrfCachePutString( key, md5seed, 30 );
110 osrfLogDebug( OSRF_LOG_MARK, "oilsAuthInit(): has seed %s and key %s", md5seed, key );
112 resp = jsonNewObject(md5seed);
113 osrfAppRespondComplete( ctx, resp );
120 jsonObjectFree(resp);
128 /** Verifies that the user has permission to login with the
129 * given type. If the permission fails, an oilsEvent is returned
131 * @return -1 if the permission check failed, 0 if ther permission
134 static int oilsAuthCheckLoginPerm(
135 osrfMethodContext* ctx, const jsonObject* userObj, const char* type ) {
137 if(!(userObj && type)) return -1;
138 oilsEvent* perm = NULL;
140 if(!strcasecmp(type, OILS_AUTH_OPAC)) {
141 char* permissions[] = { "OPAC_LOGIN" };
142 perm = oilsUtilsCheckPerms( oilsFMGetObjectId( userObj ), -1, permissions, 1 );
144 } else if(!strcasecmp(type, OILS_AUTH_STAFF)) {
145 char* permissions[] = { "STAFF_LOGIN" };
146 perm = oilsUtilsCheckPerms( oilsFMGetObjectId( userObj ), -1, permissions, 1 );
148 } else if(!strcasecmp(type, OILS_AUTH_TEMP)) {
149 char* permissions[] = { "STAFF_LOGIN" };
150 perm = oilsUtilsCheckPerms( oilsFMGetObjectId( userObj ), -1, permissions, 1 );
154 osrfAppRespondComplete( ctx, oilsEventToJSON(perm) );
163 * Returns 1 if the password provided matches the user's real password
164 * Returns 0 otherwise
165 * Returns -1 on error
167 static int oilsAuthVerifyPassword( const osrfMethodContext* ctx,
168 const jsonObject* userObj, const char* uname, const char* password ) {
171 char* realPassword = oilsFMGetString( userObj, "passwd" ); /**/
172 char* seed = osrfCacheGetString( "%s%s", OILS_AUTH_CACHE_PRFX, uname ); /**/
176 return osrfAppRequestRespondException( ctx->session,
177 ctx->request, "No authentication seed found. "
178 "open-ils.auth.authenticate.init must be called first");
181 osrfLogInternal(OSRF_LOG_MARK, "oilsAuth retrieved real password: [%s]", realPassword);
182 osrfLogDebug(OSRF_LOG_MARK, "oilsAuth retrieved seed from cache: %s", seed );
183 char* maskedPw = md5sum( "%s%s", seed, realPassword );
189 osrfLogDebug(OSRF_LOG_MARK, "oilsAuth generated masked password %s. "
190 "Testing against provided password %s", maskedPw, password );
192 if( !strcmp( maskedPw, password ) ) ret = 1;
202 * Calculates the login timeout
203 * 1. If orgloc is 1 or greater and has a timeout specified as an
204 * org unit setting, it is used
205 * 2. If orgloc is not valid, we check the org unit auth timeout
206 * setting for the home org unit of the user logging in
207 * 3. If that setting is not defined, we use the configured defaults
209 static double oilsAuthGetTimeout( const jsonObject* userObj, const char* type, double orgloc ) {
211 if(!_oilsAuthOPACTimeout) { /* Load the default timeouts */
213 jsonObject* value_obj;
215 value_obj = osrf_settings_host_value_object(
216 "/apps/open-ils.auth/app_settings/default_timeout/opac" );
217 _oilsAuthOPACTimeout = jsonObjectGetNumber(value_obj);
218 jsonObjectFree(value_obj);
220 value_obj = osrf_settings_host_value_object(
221 "/apps/open-ils.auth/app_settings/default_timeout/staff" );
222 _oilsAuthStaffTimeout = jsonObjectGetNumber(value_obj);
223 jsonObjectFree(value_obj);
225 value_obj = osrf_settings_host_value_object(
226 "/apps/open-ils.auth/app_settings/default_timeout/temp" );
227 _oilsAuthOverrideTimeout = jsonObjectGetNumber(value_obj);
228 jsonObjectFree(value_obj);
231 osrfLogInfo(OSRF_LOG_MARK, "Set default auth timetouts: opac => %d : staff => %d : temp => %d",
232 _oilsAuthOPACTimeout, _oilsAuthStaffTimeout, _oilsAuthOverrideTimeout );
235 char* setting = NULL;
237 double home_ou = jsonObjectGetNumber( oilsFMGetObject( userObj, "home_ou" ) );
238 if(orgloc < 1) orgloc = (int) home_ou;
240 if(!strcmp(type, OILS_AUTH_OPAC))
241 setting = OILS_ORG_SETTING_OPAC_TIMEOUT;
242 else if(!strcmp(type, OILS_AUTH_STAFF))
243 setting = OILS_ORG_SETTING_STAFF_TIMEOUT;
244 else if(!strcmp(type, OILS_AUTH_TEMP))
245 setting = OILS_ORG_SETTING_TEMP_TIMEOUT;
247 char* timeout = oilsUtilsFetchOrgSetting( orgloc, setting );
250 if( orgloc != home_ou ) {
251 osrfLogDebug(OSRF_LOG_MARK, "Auth timeout not defined for org %d, "
252 "trying home_ou %d", orgloc, home_ou );
253 timeout = oilsUtilsFetchOrgSetting( (int) home_ou, setting );
256 if(!strcmp(type, OILS_AUTH_STAFF)) return _oilsAuthStaffTimeout;
257 if(!strcmp(type, OILS_AUTH_TEMP)) return _oilsAuthOverrideTimeout;
258 return _oilsAuthOPACTimeout;
262 double t = atof(timeout);
267 /* Adds the authentication token to the user cache. The timeout for the
268 * auth token is based on the type of login as well as (if type=='opac')
269 * the org location id.
270 * Returns the event that should be returned to the user.
271 * Event must be freed
273 static oilsEvent* oilsAuthHandleLoginOK( jsonObject* userObj, const char* uname,
274 const char* type, double orgloc, const char* workstation ) {
279 char* wsorg = jsonObjectToSimpleString(oilsFMGetObject(userObj, "ws_ou"));
280 if(wsorg) { /* if there is a workstation, use it for the timeout */
281 osrfLogDebug( OSRF_LOG_MARK,
282 "Auth session trying workstation id %d for auth timeout", atoi(wsorg));
283 timeout = oilsAuthGetTimeout( userObj, type, atoi(wsorg) );
286 osrfLogDebug( OSRF_LOG_MARK,
287 "Auth session trying org from param [%d] for auth timeout", orgloc );
288 timeout = oilsAuthGetTimeout( userObj, type, orgloc );
290 osrfLogDebug(OSRF_LOG_MARK, "Auth session timeout for %s: %f", uname, timeout );
292 char* string = va_list_to_string(
293 "%d.%ld.%s", (long) getpid(), time(NULL), uname );
294 char* authToken = md5sum(string);
295 char* authKey = va_list_to_string(
296 "%s%s", OILS_AUTH_CACHE_PRFX, authToken );
298 const char* ws = (workstation) ? workstation : "";
299 osrfLogActivity(OSRF_LOG_MARK,
300 "successful login: username=%s, authtoken=%s, workstation=%s", uname, authToken, ws );
302 oilsFMSetString( userObj, "passwd", "" );
303 jsonObject* cacheObj = jsonParseStringFmt("{\"authtime\": %f}", timeout);
304 jsonObjectSetKey( cacheObj, "userobj", jsonObjectClone(userObj));
306 osrfCachePutObject( authKey, cacheObj, timeout );
307 jsonObjectFree(cacheObj);
308 osrfLogInternal(OSRF_LOG_MARK, "oilsAuthComplete(): Placed user object into cache");
309 jsonObject* payload = jsonParseStringFmt(
310 "{ \"authtoken\": \"%s\", \"authtime\": %f }", authToken, timeout );
312 response = oilsNewEvent2( OSRF_LOG_MARK, OILS_EVENT_SUCCESS, payload );
313 free(string); free(authToken); free(authKey);
314 jsonObjectFree(payload);
319 static oilsEvent* oilsAuthVerifyWorkstation(
320 const osrfMethodContext* ctx, jsonObject* userObj, const char* ws ) {
321 osrfLogInfo(OSRF_LOG_MARK, "Attaching workstation to user at login: %s", ws);
322 jsonObject* workstation = oilsUtilsFetchWorkstationByName(ws);
323 if(!workstation) return oilsNewEvent(OSRF_LOG_MARK, "WORKSTATION_NOT_FOUND");
324 long wsid = oilsFMGetObjectId(workstation);
325 LONG_TO_STRING(wsid);
326 char* orgid = oilsFMGetString(workstation, "owning_lib");
327 oilsFMSetString(userObj, "wsid", LONGSTR);
328 oilsFMSetString(userObj, "ws_ou", orgid);
330 jsonObjectFree(workstation);
336 /* see if the card used to login is marked as barred */
337 static oilsEvent* oilsAuthCheckCard( const char* barcode ) {
338 if(!barcode) return NULL;
339 osrfLogDebug(OSRF_LOG_MARK, "Checking to see if barcode %s is active", barcode);
341 jsonObject* params = jsonParseStringFmt("{\"barcode\":\"%s\"}", barcode);
342 jsonObject* card = oilsUtilsQuickReq(
343 "open-ils.cstore", "open-ils.cstore.direct.actor.card.search", params );
344 jsonObjectFree(params);
346 char* active = oilsFMGetString(card, "active");
347 jsonObjectFree(card);
349 oilsEvent* return_event = NULL;
350 if( ! oilsUtilsIsDBTrue(active) ) {
351 osrfLogInfo(OSRF_LOG_MARK, "barcode %s is not active, returning event", barcode);
352 return_event = oilsNewEvent(OSRF_LOG_MARK, "PATRON_CARD_INACTIVE");
361 int oilsAuthComplete( osrfMethodContext* ctx ) {
362 OSRF_METHOD_VERIFY_CONTEXT(ctx);
364 const jsonObject* args = jsonObjectGetIndex(ctx->params, 0);
366 const char* uname = jsonObjectGetString(jsonObjectGetKeyConst(args, "username"));
367 const char* password = jsonObjectGetString(jsonObjectGetKeyConst(args, "password"));
368 const char* type = jsonObjectGetString(jsonObjectGetKeyConst(args, "type"));
369 double orgloc = jsonObjectGetNumber(jsonObjectGetKeyConst(args, "org"));
370 const char* workstation = jsonObjectGetString(jsonObjectGetKeyConst(args, "workstation"));
371 char* barcode = jsonObjectToSimpleString(jsonObjectGetKeyConst(args, "barcode"));
373 const char* ws = (workstation) ? workstation : "";
376 if(!type) type = OILS_AUTH_STAFF;
378 if( !( (uname || barcode) && password) ) {
380 return osrfAppRequestRespondException( ctx->session, ctx->request,
381 "username/barcode and password required for method: %s", ctx->method->name );
384 oilsEvent* response = NULL;
385 jsonObject* userObj = NULL;
387 if(uname) userObj = oilsUtilsFetchUserByUsername( uname );
388 else if(barcode) userObj = oilsUtilsFetchUserByBarcode( barcode );
391 response = oilsNewEvent( OSRF_LOG_MARK, OILS_EVENT_AUTH_FAILED );
392 osrfLogInfo(OSRF_LOG_MARK, "failed login: username=%s, barcode=%s, workstation=%s", uname, barcode, ws );
393 osrfAppRespondComplete( ctx, oilsEventToJSON(response) );
394 oilsEventFree(response);
399 /* first let's see if they have the right credentials */
401 if(uname) passOK = oilsAuthVerifyPassword( ctx, userObj, uname, password );
403 passOK = oilsAuthVerifyPassword( ctx, userObj, barcode, password );
406 jsonObjectFree(userObj);
411 /* first see if their account is inactive */
412 char* active = oilsFMGetString(userObj, "active");
413 if( !oilsUtilsIsDBTrue(active) ) {
414 response = oilsNewEvent(OSRF_LOG_MARK, "PATRON_INACTIVE");
415 osrfAppRespondComplete( ctx, oilsEventToJSON(response) );
416 oilsEventFree(response);
417 jsonObjectFree(userObj);
424 /* then see if the barcode they used is active */
425 if( barcode && ctx && userObj && (response = oilsAuthCheckCard( barcode )) ) {
426 osrfAppRespondComplete( ctx, oilsEventToJSON(response) );
427 oilsEventFree(response);
428 jsonObjectFree(userObj);
434 /* check to see if the user is even allowed to login */
435 if( oilsAuthCheckLoginPerm( ctx, userObj, type ) == -1 ) {
436 jsonObjectFree(userObj);
442 /* if a workstation is defined, flesh the user with the workstation info */
443 if( workstation != NULL ) {
444 osrfLogDebug(OSRF_LOG_MARK, "Workstation is %s", workstation);
445 response = oilsAuthVerifyWorkstation( ctx, userObj, workstation );
447 jsonObjectFree(userObj);
448 osrfAppRespondComplete( ctx, oilsEventToJSON(response) );
449 oilsEventFree(response);
455 /* otherwise, use the home org as the workstation org on the user */
456 char* orgid = oilsFMGetString(userObj, "home_ou");
457 oilsFMSetString(userObj, "ws_ou", orgid);
461 char* freeable_uname = NULL;
463 uname = freeable_uname = oilsFMGetString( userObj, "usrname" );
467 response = oilsAuthHandleLoginOK( userObj, uname, type, orgloc, workstation );
470 response = oilsNewEvent( OSRF_LOG_MARK, OILS_EVENT_AUTH_FAILED );
471 osrfLogInfo(OSRF_LOG_MARK, "failed login: username=%s, barcode=%s, workstation=%s", uname, barcode, ws );
474 jsonObjectFree(userObj);
475 osrfAppRespondComplete( ctx, oilsEventToJSON(response) );
476 oilsEventFree(response);
479 if(freeable_uname) free(freeable_uname);
486 int oilsAuthSessionDelete( osrfMethodContext* ctx ) {
487 OSRF_METHOD_VERIFY_CONTEXT(ctx);
489 const char* authToken = jsonObjectGetString( jsonObjectGetIndex(ctx->params, 0) );
490 jsonObject* resp = NULL;
493 osrfLogDebug(OSRF_LOG_MARK, "Removing auth session: %s", authToken );
494 char* key = va_list_to_string("%s%s", OILS_AUTH_CACHE_PRFX, authToken ); /**/
495 osrfCacheRemove(key);
496 resp = jsonNewObject(authToken); /**/
500 osrfAppRespondComplete( ctx, resp );
501 jsonObjectFree(resp);
505 /** Resets the auth login timeout
506 * @return The event object, OILS_EVENT_SUCCESS, or OILS_EVENT_NO_SESSION
508 static oilsEvent* _oilsAuthResetTimeout( const char* authToken ) {
509 if(!authToken) return NULL;
511 oilsEvent* evt = NULL;
514 osrfLogDebug(OSRF_LOG_MARK, "Resetting auth timeout for session %s", authToken);
515 char* key = va_list_to_string("%s%s", OILS_AUTH_CACHE_PRFX, authToken );
516 jsonObject* cacheObj = osrfCacheGetObject( key );
519 osrfLogInfo(OSRF_LOG_MARK, "No user in the cache exists with key %s", key);
520 evt = oilsNewEvent(OSRF_LOG_MARK, OILS_EVENT_NO_SESSION);
524 timeout = jsonObjectGetNumber( jsonObjectGetKeyConst( cacheObj, "authtime"));
525 osrfCacheSetExpire( timeout, key );
526 jsonObject* payload = jsonNewNumberObject(timeout);
527 evt = oilsNewEvent2(OSRF_LOG_MARK, OILS_EVENT_SUCCESS, payload);
528 jsonObjectFree(payload);
529 jsonObjectFree(cacheObj);
536 int oilsAuthResetTimeout( osrfMethodContext* ctx ) {
537 OSRF_METHOD_VERIFY_CONTEXT(ctx);
538 const char* authToken = jsonObjectGetString( jsonObjectGetIndex(ctx->params, 0));
539 oilsEvent* evt = _oilsAuthResetTimeout(authToken);
540 osrfAppRespondComplete( ctx, oilsEventToJSON(evt) );
546 int oilsAuthSessionRetrieve( osrfMethodContext* ctx ) {
547 OSRF_METHOD_VERIFY_CONTEXT(ctx);
549 const char* authToken = jsonObjectGetString( jsonObjectGetIndex(ctx->params, 0));
550 jsonObject* cacheObj = NULL;
551 oilsEvent* evt = NULL;
555 evt = _oilsAuthResetTimeout(authToken);
557 if( evt && strcmp(evt->event, OILS_EVENT_SUCCESS) ) {
558 osrfAppRespondComplete( ctx, oilsEventToJSON(evt) );
562 osrfLogDebug(OSRF_LOG_MARK, "Retrieving auth session: %s", authToken);
563 char* key = va_list_to_string("%s%s", OILS_AUTH_CACHE_PRFX, authToken );
564 cacheObj = osrfCacheGetObject( key );
566 osrfAppRespondComplete( ctx, jsonObjectGetKeyConst( cacheObj, "userobj"));
567 jsonObjectFree(cacheObj);
569 oilsEvent* evt2 = oilsNewEvent(OSRF_LOG_MARK, OILS_EVENT_NO_SESSION);
570 osrfAppRespondComplete( ctx, oilsEventToJSON(evt2) ); /* should be event.. */
578 evt = oilsNewEvent(OSRF_LOG_MARK, OILS_EVENT_NO_SESSION);
579 osrfAppRespondComplete( ctx, oilsEventToJSON(evt) );