4 * This is an implementation of OpenID 1.1 Relying Party support, in stateless mode.
16 #include <sys/types.h>
18 #if TIME_WITH_SYS_TIME
19 # include <sys/time.h>
23 # include <sys/time.h>
32 #include <curl/curl.h>
33 #include "ctdl_module.h"
35 #include "citserver.h"
39 char claimed_id[1024];
48 /**************************************************************************/
50 /* Functions in this section handle Citadel internal OpenID mapping stuff */
52 /**************************************************************************/
56 * The structure of an openid record *key* is:
58 * |--------------claimed_id-------------|
59 * (actual length of claimed id)
62 * The structure of an openid record *value* is:
64 * |-----user_number----|------------claimed_id---------------|
65 * (sizeof long) (actual length of claimed id)
72 * Attach an OpenID to a Citadel account
74 int attach_openid(struct ctdluser *who, char *claimed_id)
76 struct cdbdata *cdboi;
82 if (!claimed_id) return(1);
83 if (IsEmptyStr(claimed_id)) return(1);
85 /* Check to see if this OpenID is already in the database */
87 cdboi = cdb_fetch(CDB_OPENID, claimed_id, strlen(claimed_id));
89 memcpy(&fetched_usernum, cdboi->ptr, sizeof(long));
92 if (fetched_usernum == who->usernum) {
93 CtdlLogPrintf(CTDL_INFO, "%s already associated; no action is taken\n", claimed_id);
97 CtdlLogPrintf(CTDL_INFO, "%s already belongs to another user\n", claimed_id);
102 /* Not already in the database, so attach it now */
104 data_len = sizeof(long) + strlen(claimed_id) + 1;
105 data = malloc(data_len);
107 memcpy(data, &who->usernum, sizeof(long));
108 memcpy(&data[sizeof(long)], claimed_id, strlen(claimed_id) + 1);
110 cdb_store(CDB_OPENID, claimed_id, strlen(claimed_id), data, data_len);
113 CtdlLogPrintf(CTDL_INFO, "%s has been associated with %s (%ld)\n",
114 claimed_id, who->fullname, who->usernum);
120 * When a user is being deleted, we have to delete any OpenID associations
122 void openid_purge(struct ctdluser *usbuf) {
123 struct cdbdata *cdboi;
124 HashList *keys = NULL;
126 char *deleteme = NULL;
131 keys = NewHash(1, NULL);
135 cdb_rewind(CDB_OPENID);
136 while (cdboi = cdb_next_item(CDB_OPENID), cdboi != NULL) {
137 if (cdboi->len > sizeof(long)) {
138 if (((long)*(cdboi->ptr)) == usbuf->usernum) {
139 deleteme = strdup(cdboi->ptr + sizeof(long)),
140 Put(keys, deleteme, strlen(deleteme), deleteme, generic_free_handler);
146 /* Go through the hash list, deleting keys we stored in it */
148 HashPos = GetNewHashPos();
149 while (GetNextHashPos(keys, HashPos, &len, &Key, &Value)!=0)
151 CtdlLogPrintf(CTDL_DEBUG, "Deleting associated OpenID <%s>\n", Value);
152 cdb_delete(CDB_OPENID, Value, strlen(Value));
153 /* note: don't free(Value) -- deleting the hash list will handle this for us */
155 DeleteHashPos(&HashPos);
162 * List the OpenIDs associated with the currently logged in account
164 void cmd_oidl(char *argbuf) {
165 struct cdbdata *cdboi;
167 if (CtdlAccessCheck(ac_logged_in)) return;
168 cdb_rewind(CDB_OPENID);
169 cprintf("%d Associated OpenIDs:\n", LISTING_FOLLOWS);
171 while (cdboi = cdb_next_item(CDB_OPENID), cdboi != NULL) {
172 if (cdboi->len > sizeof(long)) {
173 if (((long)*(cdboi->ptr)) == CC->user.usernum) {
174 cprintf("%s\n", cdboi->ptr + sizeof(long));
185 * Detach an OpenID from the currently logged in account
187 void cmd_oidd(char *argbuf) {
188 struct cdbdata *cdboi;
189 char id_to_detach[1024];
190 int this_is_mine = 0;
192 if (CtdlAccessCheck(ac_logged_in)) return;
193 extract_token(id_to_detach, argbuf, 0, '|', sizeof id_to_detach);
194 if (IsEmptyStr(id_to_detach)) {
195 cprintf("%d An empty OpenID URL is not allowed.\n", ERROR + ILLEGAL_VALUE);
198 cdb_rewind(CDB_OPENID);
199 while (cdboi = cdb_next_item(CDB_OPENID), cdboi != NULL) {
200 if (cdboi->len > sizeof(long)) {
201 if (((long)*(cdboi->ptr)) == CC->user.usernum) {
209 cprintf("%d That OpenID was not found or not associated with your account.\n",
210 ERROR + ILLEGAL_VALUE);
214 cdb_delete(CDB_OPENID, id_to_detach, strlen(id_to_detach));
215 cprintf("%d %s detached from your account.\n", CIT_OK, id_to_detach);
221 * Attempt to auto-create a new Citadel account using the nickname from Simple Registration Extension
223 int openid_create_user_via_sri(char *claimed_id, HashList *sri_keys)
225 char *desired_name = NULL;
227 if (config.c_auth_mode != AUTHMODE_NATIVE) return(1);
228 if (config.c_disable_newu) return(2);
229 if (CC->logged_in) return(3);
230 if (!GetHash(sri_keys, "sreg.nickname", 13, (void *) &desired_name)) return(4);
232 CtdlLogPrintf(CTDL_DEBUG, "The desired account name is <%s>\n", desired_name);
234 if (!getuser(&CC->user, desired_name)) {
235 CtdlLogPrintf(CTDL_DEBUG, "<%s> is already taken by another user.\n", desired_name);
236 memset(&CC->user, 0, sizeof(struct ctdluser));
240 /* The desired account name is available. Create the account and log it in! */
241 if (create_user(desired_name, 1)) return(6);
243 attach_openid(&CC->user, claimed_id);
248 // identity = [50] http://uncensored.citadel.org/~ajc/MyID.config.php
249 // sreg.nickname = [17] IGnatius T Foobar
250 // sreg.email = [26] ajc@uncensored.citadel.org
251 // sreg.fullname = [10] Art Cancro
252 // sreg.postcode = [5] 10549
253 // sreg.country = [2] US
258 * If a user account exists which is associated with the Claimed ID, log it in and return zero.
259 * Otherwise it returns nonzero.
261 int login_via_openid(char *claimed_id)
263 struct cdbdata *cdboi;
266 cdboi = cdb_fetch(CDB_OPENID, claimed_id, strlen(claimed_id));
271 memcpy(&usernum, cdboi->ptr, sizeof(long));
274 if (!getuserbynumber(&CC->user, usernum)) {
279 memset(&CC->user, 0, sizeof(struct ctdluser));
287 /**************************************************************************/
289 /* Functions in this section handle OpenID protocol */
291 /**************************************************************************/
295 * Locate a <link> tag and, given its 'rel=' parameter, return its 'href' parameter
297 void extract_link(char *target_buf, int target_size, char *rel, char *source_buf)
299 char *ptr = source_buf;
301 if (!target_buf) return;
303 if (!source_buf) return;
307 while (ptr = bmstrcasestr(ptr, "<link"), ptr != NULL) {
309 char work_buffer[2048];
310 char *link_tag_start = NULL;
311 char *link_tag_end = NULL;
316 link_tag_start = ptr;
317 link_tag_end = strchr(ptr, '>');
321 if ((link_tag_end) && (link_tag_end > link_tag_start)) {
323 len = link_tag_end - link_tag_start;
324 if (len > sizeof work_buffer) len = sizeof work_buffer;
325 memcpy(work_buffer, link_tag_start, len);
327 char *rel_start = NULL;
328 char *rel_end = NULL;
329 rel_start = bmstrcasestr(work_buffer, "rel=");
331 rel_start = strchr(rel_start, '\"');
334 rel_end = strchr(rel_start, '\"');
335 if ((rel_end) && (rel_end > rel_start)) {
336 safestrncpy(rel_tag, rel_start, rel_end - rel_start + 1);
341 char *href_start = NULL;
342 char *href_end = NULL;
343 href_start = bmstrcasestr(work_buffer, "href=");
345 href_start = strchr(href_start, '\"');
348 href_end = strchr(href_start, '\"');
349 if ((href_end) && (href_end > href_start)) {
350 safestrncpy(href_tag, href_start, href_end - href_start + 1);
355 if (!strcasecmp(rel, rel_tag)) {
356 safestrncpy(target_buf, href_tag, target_size);
372 int total_bytes_received;
377 size_t fh_callback(void *ptr, size_t size, size_t nmemb, void *stream)
379 struct fh_data *fh = (struct fh_data *) stream;
380 int got_bytes = (size * nmemb);
382 if (fh->total_bytes_received + got_bytes > fh->maxbytes) {
383 got_bytes = fh->maxbytes - fh->total_bytes_received;
386 memcpy(&fh->buf[fh->total_bytes_received], ptr, got_bytes);
387 fh->total_bytes_received += got_bytes;
390 return (size * nmemb); /* always succeed; libcurl doesn't need to know if we truncated it */
396 * Begin an HTTP fetch (returns number of bytes actually fetched, or -1 for error) using libcurl.
398 * If 'normalize_len' is nonzero, the caller is specifying the buffer size of 'url', and is
399 * requesting that the effective (normalized) URL be copied back to it.
401 int fetch_http(char *url, char *target_buf, int maxbytes, int normalize_len)
405 char errmsg[1024] = "";
406 struct fh_data fh = {
411 char *effective_url = NULL;
413 if (!url) return(-1);
414 if (!target_buf) return(-1);
415 memset(target_buf, 0, maxbytes);
417 curl = curl_easy_init();
419 CtdlLogPrintf(CTDL_ALERT, "Unable to initialize libcurl.\n");
423 curl_easy_setopt(curl, CURLOPT_URL, url);
424 curl_easy_setopt(curl, CURLOPT_SSL_VERIFYPEER, 0);
425 curl_easy_setopt(curl, CURLOPT_SSL_VERIFYHOST, 0);
426 curl_easy_setopt(curl, CURLOPT_WRITEDATA, &fh);
427 curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, fh_callback);
428 curl_easy_setopt(curl, CURLOPT_ERRORBUFFER, errmsg);
429 curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1);
430 curl_easy_setopt(curl, CURLOPT_USERAGENT, CITADEL);
431 if (!IsEmptyStr(config.c_ip_addr)) {
432 curl_easy_setopt(curl, CURLOPT_INTERFACE, config.c_ip_addr);
434 res = curl_easy_perform(curl);
436 CtdlLogPrintf(CTDL_DEBUG, "fetch_http() libcurl error %d: %s\n", res, errmsg);
438 if (normalize_len > 0) {
439 curl_easy_getinfo(curl, CURLINFO_EFFECTIVE_URL, &effective_url);
440 safestrncpy(url, effective_url, normalize_len);
442 curl_easy_cleanup(curl);
443 return fh.total_bytes_received;
448 * Setup an OpenID authentication
450 void cmd_oids(char *argbuf) {
451 char return_to[1024];
452 char trust_root[1024];
455 struct CitContext *CCC = CC; /* CachedCitContext - performance boost */
456 struct ctdl_openid *oiddata;
458 /* commented out because we may be attempting to attach an OpenID to
459 * an existing account that is logged in
461 if (CCC->logged_in) {
462 cprintf("%d Already logged in.\n", ERROR + ALREADY_LOGGED_IN);
467 if (CCC->openid_data != NULL) {
468 free(CCC->openid_data);
470 oiddata = malloc(sizeof(struct ctdl_openid));
471 if (oiddata == NULL) {
472 cprintf("%d malloc failed\n", ERROR + INTERNAL_ERROR);
475 memset(oiddata, 0, sizeof(struct ctdl_openid));
476 CCC->openid_data = (void *) oiddata;
478 extract_token(oiddata->claimed_id, argbuf, 0, '|', sizeof oiddata->claimed_id);
479 extract_token(return_to, argbuf, 1, '|', sizeof return_to);
480 extract_token(trust_root, argbuf, 2, '|', sizeof trust_root);
481 oiddata->validated = 0;
483 i = fetch_http(oiddata->claimed_id, buf, sizeof buf - 1, sizeof oiddata->claimed_id);
484 CtdlLogPrintf(CTDL_DEBUG, "Normalized URL and Claimed ID is: %s\n", oiddata->claimed_id);
485 buf[sizeof buf - 1] = 0;
487 char openid_delegate[1024];
489 extract_link(oiddata->server, sizeof oiddata->server, "openid.server", buf);
490 extract_link(openid_delegate, sizeof openid_delegate, "openid.delegate", buf);
492 if (IsEmptyStr(oiddata->server)) {
493 cprintf("%d There is no OpenID identity provider at this URL.\n", ERROR);
497 /* Empty delegate is legal; we just use the openid_url instead */
498 if (IsEmptyStr(openid_delegate)) {
499 safestrncpy(openid_delegate, oiddata->claimed_id, sizeof openid_delegate);
502 /* Assemble a URL to which the user-agent will be redirected. */
503 char redirect_string[4096];
504 char escaped_identity[512];
505 char escaped_return_to[2048];
506 char escaped_trust_root[1024];
507 char escaped_sreg_optional[256];
509 urlesc(escaped_identity, sizeof escaped_identity, openid_delegate);
510 urlesc(escaped_return_to, sizeof escaped_return_to, return_to);
511 urlesc(escaped_trust_root, sizeof escaped_trust_root, trust_root);
512 urlesc(escaped_sreg_optional, sizeof escaped_sreg_optional,
513 "nickname,email,fullname,postcode,country");
515 snprintf(redirect_string, sizeof redirect_string,
517 "?openid.mode=checkid_setup"
518 "&openid.identity=%s"
519 "&openid.return_to=%s"
520 "&openid.trust_root=%s"
521 "&openid.sreg.optional=%s"
527 escaped_sreg_optional
529 cprintf("%d %s\n", CIT_OK, redirect_string);
533 cprintf("%d Unable to fetch OpenID URL\n", ERROR);
541 * Finalize an OpenID authentication
543 void cmd_oidf(char *argbuf) {
547 HashList *keys = NULL;
548 struct ctdl_openid *oiddata = (struct ctdl_openid *) CC->openid_data;
550 keys = NewHash(1, NULL);
552 cprintf("%d NewHash() failed\n", ERROR + INTERNAL_ERROR);
556 cprintf("%d Transmit OpenID data now\n", START_CHAT_MODE);
558 while (client_getln(buf, sizeof buf), strcmp(buf, "000")) {
559 extract_token(thiskey, buf, 0, '|', sizeof thiskey);
560 extract_token(thisdata, buf, 1, '|', sizeof thisdata);
561 CtdlLogPrintf(CTDL_DEBUG, "%s: [%d] %s\n", thiskey, strlen(thisdata), thisdata);
562 Put(keys, thiskey, strlen(thiskey), strdup(thisdata), generic_free_handler);
566 /* Now that we have all of the parameters, we have to validate the signature against the server */
567 CtdlLogPrintf(CTDL_DEBUG, "About to validate the signature...\n");
571 struct curl_httppost *formpost = NULL;
572 struct curl_httppost *lastptr = NULL;
573 char errmsg[1024] = "";
574 char *o_assoc_handle = NULL;
576 char *o_signed = NULL;
577 int num_signed_values;
580 char k_o_keyname[128];
581 char *k_value = NULL;
584 struct fh_data fh = {
590 curl_formadd(&formpost, &lastptr,
591 CURLFORM_COPYNAME, "openid.mode",
592 CURLFORM_COPYCONTENTS, "check_authentication",
594 CtdlLogPrintf(CTDL_DEBUG, "%25s : %s\n", "openid.mode", "check_authentication");
596 if (GetHash(keys, "assoc_handle", 12, (void *) &o_assoc_handle)) {
597 curl_formadd(&formpost, &lastptr,
598 CURLFORM_COPYNAME, "openid.assoc_handle",
599 CURLFORM_COPYCONTENTS, o_assoc_handle,
601 CtdlLogPrintf(CTDL_DEBUG, "%25s : %s\n", "openid.assoc_handle", o_assoc_handle);
604 if (GetHash(keys, "sig", 3, (void *) &o_sig)) {
605 curl_formadd(&formpost, &lastptr,
606 CURLFORM_COPYNAME, "openid.sig",
607 CURLFORM_COPYCONTENTS, o_sig,
609 CtdlLogPrintf(CTDL_DEBUG, "%25s : %s\n", "openid.sig", o_sig);
612 if (GetHash(keys, "signed", 6, (void *) &o_signed)) {
613 curl_formadd(&formpost, &lastptr,
614 CURLFORM_COPYNAME, "openid.signed",
615 CURLFORM_COPYCONTENTS, o_signed,
617 CtdlLogPrintf(CTDL_DEBUG, "%25s : %s\n", "openid.signed", o_signed);
619 num_signed_values = num_tokens(o_signed, ',');
620 for (i=0; i<num_signed_values; ++i) {
621 extract_token(k_keyname, o_signed, i, ',', sizeof k_keyname);
622 if (strcasecmp(k_keyname, "mode")) { // work around phpMyID bug
623 if (GetHash(keys, k_keyname, strlen(k_keyname), (void *) &k_value)) {
624 snprintf(k_o_keyname, sizeof k_o_keyname, "openid.%s", k_keyname);
625 curl_formadd(&formpost, &lastptr,
626 CURLFORM_COPYNAME, k_o_keyname,
627 CURLFORM_COPYCONTENTS, k_value,
629 CtdlLogPrintf(CTDL_DEBUG, "%25s : %s\n", k_o_keyname, k_value);
632 CtdlLogPrintf(CTDL_INFO, "OpenID: signed field '%s' is missing\n",
639 curl = curl_easy_init();
640 curl_easy_setopt(curl, CURLOPT_URL, oiddata->server);
641 curl_easy_setopt(curl, CURLOPT_SSL_VERIFYPEER, 0);
642 curl_easy_setopt(curl, CURLOPT_SSL_VERIFYHOST, 0);
643 curl_easy_setopt(curl, CURLOPT_WRITEDATA, &fh);
644 curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, fh_callback);
645 curl_easy_setopt(curl, CURLOPT_HTTPPOST, formpost);
646 curl_easy_setopt(curl, CURLOPT_ERRORBUFFER, errmsg);
647 curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1);
648 curl_easy_setopt(curl, CURLOPT_USERAGENT, CITADEL);
649 if (!IsEmptyStr(config.c_ip_addr)) {
650 curl_easy_setopt(curl, CURLOPT_INTERFACE, config.c_ip_addr);
653 res = curl_easy_perform(curl);
655 CtdlLogPrintf(CTDL_DEBUG, "cmd_oidf() libcurl error %d: %s\n", res, errmsg);
657 curl_easy_cleanup(curl);
658 curl_formfree(formpost);
660 valbuf[fh.total_bytes_received] = 0;
662 if (bmstrcasestr(valbuf, "is_valid:true")) {
663 oiddata->validated = 1;
666 CtdlLogPrintf(CTDL_DEBUG, "Authentication %s.\n", (oiddata->validated ? "succeeded" : "failed") );
668 /* Respond to the client */
670 if (oiddata->validated) {
672 /* If we were already logged in, attach the OpenID to the user's account */
674 if (attach_openid(&CC->user, oiddata->claimed_id) == 0) {
682 /* Otherwise, a user is attempting to log in using the validated OpenID */
685 * Existing user who has claimed this OpenID?
687 * Note: if you think that sending the password back over the wire is insecure,
688 * check your assumptions. If someone has successfully asserted an OpenID that
689 * is associated with the account, they already have password equivalency and can
690 * login, so they could just as easily change the password, etc.
692 if (login_via_openid(oiddata->claimed_id) == 0) {
693 cprintf("authenticate\n%s\n%s\n", CC->user.fullname, CC->user.password);
694 logged_in_response();
698 * New user whose OpenID is verified and Simple Registration Extension is in use?
700 else if (openid_create_user_via_sri(oiddata->claimed_id, keys) == 0) {
701 cprintf("authenticate\n%s\n%s\n", CC->user.fullname, CC->user.password);
702 logged_in_response();
705 /* FIXME right here we have to handle manual account creation */
718 * We will eventually do something with the data in the hash list.
724 HashPos = GetNewHashPos();
725 while (GetNextHashPos(keys, HashPos, &len, &Key, &Value)!=0)
728 DeleteHashPos(&HashPos);
731 DeleteHash(&keys); /* This will free() all the key data for us */
736 /**************************************************************************/
738 /* Functions in this section handle module initialization and shutdown */
740 /**************************************************************************/
744 * This cleanup function blows away the temporary memory used by this module.
746 void openid_cleanup_function(void) {
748 if (CC->openid_data != NULL) {
749 free(CC->openid_data);
754 CTDL_MODULE_INIT(openid_rp)
758 curl_global_init(CURL_GLOBAL_ALL);
759 CtdlRegisterProtoHook(cmd_oids, "OIDS", "Setup OpenID authentication");
760 CtdlRegisterProtoHook(cmd_oidf, "OIDF", "Finalize OpenID authentication");
761 CtdlRegisterProtoHook(cmd_oidl, "OIDL", "List OpenIDs associated with an account");
762 CtdlRegisterProtoHook(cmd_oidd, "OIDD", "Detach an OpenID from an account");
763 CtdlRegisterSessionHook(openid_cleanup_function, EVT_STOP);
764 CtdlRegisterUserHook(openid_purge, EVT_PURGEUSER);
767 /* return our Subversion id for the Log */
772 /* FIXME ... we have to add the new openid database to serv_vandelay.c */