/** BEGIN COPYRIGHT BLOCK * Copyright (C) 2013 Red Hat, Inc. * All rights reserved. * * License: GPL (version 3 or any later version). * See LICENSE for details. * END COPYRIGHT BLOCK **/ #include "sync.h" #include "slap.h" /* for LDAP_TAG_SK_REVERSE */ static struct berval *create_syncinfo_value(int type, const char *cookie, const char **uuids); static char *sync_cookie_get_server_info(Slapi_PBlock *pb); static char *sync_cookie_get_client_info(Slapi_PBlock *pb); /* * Parse the value from an LDAPv3 sync request control. They look * like this: * * syncRequestValue ::= SEQUENCE { * mode ENUMERATED { * -- 0 unused * refreshOnly (1), * -- 2 reserved * refreshAndPersist (3) * }, * cookie syncCookie OPTIONAL, * reloadHint BOOLEAN DEFAULT FALSE * } * * Return an LDAP error code (LDAP_SUCCESS if all goes well). * */ int sync_parse_control_value(struct berval *psbvp, ber_int_t *mode, int *reload, char **cookie) { int rc = LDAP_SUCCESS; if (psbvp->bv_len == 0 || psbvp->bv_val == NULL) { rc = LDAP_PROTOCOL_ERROR; } else { BerElement *ber = ber_init(psbvp); if (ber == NULL) { rc = LDAP_OPERATIONS_ERROR; } else { if (ber_scanf(ber, "{e", mode) == LBER_ERROR) { rc = LDAP_PROTOCOL_ERROR; } else { ber_tag_t tag; ber_len_t len; tag = ber_peek_tag(ber, &len); if (tag == LDAP_TAG_SYNC_COOKIE) { rc = ber_scanf(ber, "a", cookie); tag = ber_peek_tag(ber, &len); } if (rc != LBER_ERROR && tag == LDAP_TAG_RELOAD_HINT) { rc = ber_scanf(ber, "b", reload); } if (rc != LBER_ERROR) { rc = ber_scanf(ber, "}"); } if (rc == LBER_ERROR) { rc = LDAP_PROTOCOL_ERROR; }; } /* the ber encoding is no longer needed */ ber_free(ber, 1); } } return (rc); } char * sync_nsuniqueid2uuid(const char *nsuniqueid) { char *uuid; char u[17]; u[0] = slapi_str_to_u8(nsuniqueid); u[1] = slapi_str_to_u8(nsuniqueid + 2); u[2] = slapi_str_to_u8(nsuniqueid + 4); u[3] = slapi_str_to_u8(nsuniqueid + 6); u[4] = slapi_str_to_u8(nsuniqueid + 9); u[5] = slapi_str_to_u8(nsuniqueid + 11); u[6] = slapi_str_to_u8(nsuniqueid + 13); u[7] = slapi_str_to_u8(nsuniqueid + 15); u[8] = slapi_str_to_u8(nsuniqueid + 18); u[9] = slapi_str_to_u8(nsuniqueid + 20); u[10] = slapi_str_to_u8(nsuniqueid + 22); u[11] = slapi_str_to_u8(nsuniqueid + 24); u[12] = slapi_str_to_u8(nsuniqueid + 27); u[13] = slapi_str_to_u8(nsuniqueid + 29); u[14] = slapi_str_to_u8(nsuniqueid + 31); u[15] = slapi_str_to_u8(nsuniqueid + 33); u[16] = '\0'; uuid = slapi_ch_malloc(sizeof(u)); memcpy(uuid, u, sizeof(u)); return (uuid); } /* * syncStateValue ::= SEQUENCE { * state ENUMERATED { * present (0), * add (1), * modify (2), * delete (3) * }, * entryUUID syncUUID, * cookie syncCookie OPTIONAL * } * */ int sync_create_state_control(Slapi_Entry *e, LDAPControl **ctrlp, int type, Sync_Cookie *cookie) { int rc; BerElement *ber; struct berval *bvp; char *uuid; Slapi_Attr *attr; Slapi_Value *val; if (type == LDAP_SYNC_NONE || ctrlp == NULL || (ber = der_alloc()) == NULL) { return (LDAP_OPERATIONS_ERROR); } *ctrlp = NULL; slapi_entry_attr_find(e, SLAPI_ATTR_UNIQUEID, &attr); slapi_attr_first_value(attr, &val); uuid = sync_nsuniqueid2uuid(slapi_value_get_string(val)); if ((rc = ber_printf(ber, "{eo", type, uuid, 16)) != -1) { if (cookie) { char *cookiestr = sync_cookie2str(cookie); rc = ber_printf(ber, "s}", cookiestr); slapi_ch_free((void **)&cookiestr); } else { rc = ber_printf(ber, "}"); } } if (rc != -1) { rc = ber_flatten(ber, &bvp); } ber_free(ber, 1); slapi_ch_free((void **)&uuid); if (rc == -1) { return (LDAP_OPERATIONS_ERROR); } *ctrlp = (LDAPControl *)slapi_ch_malloc(sizeof(LDAPControl)); (*ctrlp)->ldctl_iscritical = 0; (*ctrlp)->ldctl_oid = slapi_ch_strdup(LDAP_CONTROL_SYNC_STATE); (*ctrlp)->ldctl_value = *bvp; /* struct copy */ bvp->bv_val = NULL; ber_bvfree(bvp); return (LDAP_SUCCESS); } /* * syncDoneValue ::= SEQUENCE { * cookie syncCookie OPTIONAL * refreshDeletes BOOLEAN DEFAULT FALSE * } * */ int sync_create_sync_done_control(LDAPControl **ctrlp, int refresh, char *cookie) { int rc; BerElement *ber; struct berval *bvp; if (ctrlp == NULL || (ber = der_alloc()) == NULL) { return (LDAP_OPERATIONS_ERROR); } *ctrlp = NULL; if (cookie) { if ((rc = ber_printf(ber, "{s", cookie)) != -1) { if (refresh) { rc = ber_printf(ber, "e}", refresh); } else { rc = ber_printf(ber, "}"); } } } else { if (refresh) { rc = ber_printf(ber, "{e}", refresh); } else { rc = ber_printf(ber, "{}"); } } if (rc != -1) { rc = ber_flatten(ber, &bvp); } ber_free(ber, 1); if (rc == -1) { return (LDAP_OPERATIONS_ERROR); } *ctrlp = (LDAPControl *)slapi_ch_malloc(sizeof(LDAPControl)); (*ctrlp)->ldctl_iscritical = 0; (*ctrlp)->ldctl_oid = slapi_ch_strdup(LDAP_CONTROL_SYNC_DONE); (*ctrlp)->ldctl_value = *bvp; /* struct copy */ bvp->bv_val = NULL; ber_bvfree(bvp); return (LDAP_SUCCESS); } char * sync_cookie2str(Sync_Cookie *cookie) { char *cookiestr = NULL; if (cookie) { cookiestr = slapi_ch_smprintf("%s#%s#%lu", cookie->cookie_server_signature, cookie->cookie_client_signature, cookie->cookie_change_info); } return (cookiestr); } int sync_intermediate_msg(Slapi_PBlock *pb, int tag, Sync_Cookie *cookie, char **uuids) { int rc; struct berval *syncInfo; LDAPControl *ctrlp = NULL; char *cookiestr = sync_cookie2str(cookie); syncInfo = create_syncinfo_value(tag, cookiestr, (const char **)uuids); rc = slapi_send_ldap_intermediate(pb, &ctrlp, LDAP_SYNC_INFO, syncInfo); slapi_ch_free((void **)&cookiestr); ber_bvfree(syncInfo); return (rc); } int sync_result_msg(Slapi_PBlock *pb, Sync_Cookie *cookie) { int rc = 0; char *cookiestr = sync_cookie2str(cookie); LDAPControl **ctrl = (LDAPControl **)slapi_ch_calloc(2, sizeof(LDAPControl *)); sync_create_sync_done_control(&ctrl[0], 0, cookiestr); slapi_pblock_set(pb, SLAPI_RESCONTROLS, ctrl); slapi_send_ldap_result(pb, 0, NULL, NULL, 0, NULL); slapi_ch_free((void **)&cookiestr); return (rc); } int sync_result_err(Slapi_PBlock *pb, int err, char *msg) { int rc = 0; slapi_send_ldap_result(pb, err, NULL, msg, 0, NULL); return (rc); } static struct berval * create_syncinfo_value(int type, const char *cookie, const char **uuids) { BerElement *ber; struct berval *bvp = NULL; if ((ber = der_alloc()) == NULL) { return (NULL); } switch (type) { case LDAP_TAG_SYNC_NEW_COOKIE: ber_printf(ber, "to", type, cookie); break; case LDAP_TAG_SYNC_REFRESH_DELETE: case LDAP_TAG_SYNC_REFRESH_PRESENT: ber_printf(ber, "t{", type); if (cookie) ber_printf(ber, "s", cookie); /* ber_printf(ber, "b",1); */ ber_printf(ber, "}"); break; case LDAP_TAG_SYNC_ID_SET: ber_printf(ber, "t{", type); if (cookie) ber_printf(ber, "s", cookie); if (uuids) ber_printf(ber, "b[v]", 1, uuids); ber_printf(ber, "}"); break; default: break; } ber_flatten(ber, &bvp); ber_free(ber, 1); return (bvp); } static int sync_handle_cnum_entry(Slapi_Entry *e, void *cb_data) { int rc = 0; Sync_CallBackData *cb = (Sync_CallBackData *)cb_data; Slapi_Value *sval = NULL; const struct berval *value; cb->changenr = 0; if (NULL != e) { Slapi_Attr *chattr = NULL; sval = NULL; value = NULL; if (slapi_entry_attr_find(e, CL_ATTR_CHANGENUMBER, &chattr) == 0) { slapi_attr_first_value(chattr, &sval); if (NULL != sval) { value = slapi_value_get_berval(sval); if (value && value->bv_val && ('\0' != value->bv_val[0])) { cb->changenr = sync_number2ulong(value->bv_val); if (SYNC_INVALID_CHANGENUM != cb->changenr) { cb->cb_err = 0; /* changenr successfully set */ } } } } } return (rc); } /* * a cookie is used to synchronize client server sessions, * it consist of three parts * -- server id, client should only sync with one server * -- client id, client should use same bind dn, and srch params * -- change info, kind of state info like csn, ruv, * in the first implementation use changenumber from retro cl * * syntax: ##change * */ static char * sync_cookie_get_server_info(Slapi_PBlock *pb __attribute__((unused))) { char *info_enc; int rc = 0; Slapi_Entry **entries; Slapi_PBlock *srch_pb = NULL; const char *host = NULL; const char *port = NULL; char *server_attrs[] = {"nsslapd-localhost", "nsslapd-port", NULL}; srch_pb = slapi_pblock_new(); slapi_search_internal_set_pb(srch_pb, "cn=config", LDAP_SCOPE_BASE, "objectclass=*", server_attrs, 0, NULL, NULL, plugin_get_default_component_id(), 0); slapi_search_internal_pb(srch_pb); slapi_pblock_get(srch_pb, SLAPI_PLUGIN_INTOP_RESULT, &rc); if (rc != 0) { slapi_log_err(SLAPI_LOG_ERR, SYNC_PLUGIN_SUBSYSTEM, "sync_cookie_get_server_info - " "Unable to read server configuration: error %d\n", rc); } else { slapi_pblock_get(srch_pb, SLAPI_PLUGIN_INTOP_SEARCH_ENTRIES, &entries); if (NULL == entries || NULL == entries[0]) { slapi_log_err(SLAPI_LOG_ERR, SYNC_PLUGIN_SUBSYSTEM, "sync_cookie_get_server_info -" "Server configuration missing\n"); rc = -1; } else { host = slapi_entry_attr_get_ref(entries[0], "nsslapd-localhost"); port = slapi_entry_attr_get_ref(entries[0], "nsslapd-port"); } } info_enc = slapi_ch_smprintf("%s:%s", host ? host : "nohost", port ? port : "noport"); slapi_free_search_results_internal(srch_pb); slapi_pblock_destroy(srch_pb); return (info_enc); } static char * sync_cookie_get_client_info(Slapi_PBlock *pb) { char *targetdn; char *strfilter; char *clientdn; char *clientinfo; slapi_pblock_get(pb, SLAPI_TARGET_DN, &targetdn); slapi_pblock_get(pb, SLAPI_SEARCH_STRFILTER, &strfilter); slapi_pblock_get(pb, SLAPI_REQUESTOR_DN, &clientdn); clientinfo = slapi_ch_smprintf("%s:%s:%s", clientdn, targetdn, strfilter); return (clientinfo); } /* This is used with internal search that reverse the order * of returned entries. So to get */ static LDAPControl * sync_build_sort_control(const char *attr) { LDAPControl *ctrl; BerElement *ber; int rc; ber = ber_alloc(); if (NULL == ber) return NULL; rc = ber_printf(ber, "{{stb}}", attr, LDAP_TAG_SK_REVERSE, 1); if (-1 == rc) { ber_free(ber, 1); return NULL; } rc = slapi_build_control(LDAP_CONTROL_SORTREQUEST, ber, 1, &ctrl); ber_free(ber, 1); if (LDAP_SUCCESS != rc) return NULL; return ctrl; } static unsigned long sync_cookie_get_change_number(int lastnr, const char *uniqueid) { Slapi_PBlock *srch_pb; Slapi_Entry **entries; Slapi_Entry *cl_entry; int rv; unsigned long newnr = SYNC_INVALID_CHANGENUM; LDAPControl **ctrls = NULL; ctrls = (LDAPControl **)slapi_ch_calloc(2, sizeof(LDAPControl *)); char *filter = slapi_ch_smprintf("(&(changenumber>=%d)(targetuniqueid=%s))", lastnr + 1, uniqueid); ctrls[0] = sync_build_sort_control("changenumber"); srch_pb = slapi_pblock_new(); slapi_search_internal_set_pb(srch_pb, CL_SRCH_BASE, LDAP_SCOPE_SUBTREE, filter, NULL, 0, ctrls, NULL, plugin_get_default_component_id(), 0); slapi_search_internal_pb(srch_pb); slapi_pblock_get(srch_pb, SLAPI_PLUGIN_INTOP_RESULT, &rv); if (rv == LDAP_SUCCESS) { slapi_pblock_get(srch_pb, SLAPI_PLUGIN_INTOP_SEARCH_ENTRIES, &entries); if (entries && *entries) { Slapi_Attr *attr; Slapi_Value *val; cl_entry = *entries; /* only use teh first one */ slapi_entry_attr_find(cl_entry, CL_ATTR_CHANGENUMBER, &attr); slapi_attr_first_value(attr, &val); newnr = sync_number2ulong((char *)slapi_value_get_string(val)); } #if DEBUG slapi_log_err(SLAPI_LOG_PLUGIN, SYNC_PLUGIN_SUBSYSTEM, "sync_cookie_get_change_number looks for \"%s\"\n", filter); for (size_t i = 0; entries[i]; i++) { Slapi_Attr *attr; Slapi_Value *val; char *entrydn; unsigned long nr; slapi_entry_attr_find(entries[i], CL_ATTR_ENTRYDN, &attr); slapi_attr_first_value(attr, &val); entrydn = (char *)slapi_value_get_string(val); slapi_entry_attr_find(entries[i], CL_ATTR_CHANGENUMBER, &attr); slapi_attr_first_value(attr, &val); nr = sync_number2ulong((char *)slapi_value_get_string(val)); slapi_log_err(SLAPI_LOG_PLUGIN, SYNC_PLUGIN_SUBSYSTEM, "sync_cookie_get_change_number after %d: %d %s\n", lastnr, (int) nr, entrydn); } #endif } slapi_free_search_results_internal(srch_pb); slapi_pblock_destroy(srch_pb); slapi_ch_free((void **)&filter); return (newnr); } static int sync_cookie_get_change_info(Sync_CallBackData *scbd) { Slapi_PBlock *seq_pb; char *base; char *attrname; int rc; base = slapi_ch_strdup("cn=changelog"); attrname = slapi_ch_strdup("changenumber"); seq_pb = slapi_pblock_new(); slapi_pblock_init(seq_pb); slapi_seq_internal_set_pb(seq_pb, base, SLAPI_SEQ_LAST, attrname, NULL, NULL, 0, 0, plugin_get_default_component_id(), 0); rc = slapi_seq_internal_callback_pb(seq_pb, scbd, NULL, sync_handle_cnum_entry, NULL); slapi_pblock_destroy(seq_pb); slapi_ch_free((void **)&attrname); slapi_ch_free((void **)&base); return (rc); } Sync_Cookie * sync_cookie_create(Slapi_PBlock *pb) { Sync_CallBackData scbd; int rc; Sync_Cookie *sc = (Sync_Cookie *)slapi_ch_calloc(1, sizeof(Sync_Cookie)); scbd.cb_err = SYNC_CALLBACK_PREINIT; rc = sync_cookie_get_change_info(&scbd); if (rc == 0) { sc->cookie_server_signature = sync_cookie_get_server_info(pb); sc->cookie_client_signature = sync_cookie_get_client_info(pb); if (scbd.cb_err == SYNC_CALLBACK_PREINIT) { /* changenr is not initialized. */ sc->cookie_change_info = 0; } else { sc->cookie_change_info = scbd.changenr; } } else { slapi_ch_free((void **)&sc); sc = NULL; } return (sc); } void sync_cookie_update(Sync_Cookie *sc, Slapi_Entry *ec) { const char *uniqueid = NULL; Slapi_Attr *attr; Slapi_Value *val; slapi_entry_attr_find(ec, SLAPI_ATTR_UNIQUEID, &attr); slapi_attr_first_value(attr, &val); uniqueid = slapi_value_get_string(val); sc->cookie_change_info = sync_cookie_get_change_number(sc->cookie_change_info, uniqueid); } Sync_Cookie * sync_cookie_parse(char *cookie) { char *p, *q; Sync_Cookie *sc = NULL; if (cookie == NULL || *cookie == '\0') { return NULL; } /* * Format of cookie: server_signature#client_signature#change_info_number * If the cookie is malformed, NULL is returned. */ p = q = cookie; p = strchr(q, '#'); if (p) { *p = '\0'; sc = (Sync_Cookie *)slapi_ch_calloc(1, sizeof(Sync_Cookie)); sc->cookie_server_signature = slapi_ch_strdup(q); q = p + 1; p = strchr(q, '#'); if (p) { *p = '\0'; sc->cookie_client_signature = slapi_ch_strdup(q); sc->cookie_change_info = sync_number2ulong(p + 1); if (SYNC_INVALID_CHANGENUM == sc->cookie_change_info) { goto error_return; } } else { goto error_return; } } return (sc); error_return: slapi_ch_free_string(&(sc->cookie_client_signature)); slapi_ch_free_string(&(sc->cookie_server_signature)); slapi_ch_free((void **)&sc); return NULL; } int sync_cookie_isvalid(Sync_Cookie *testcookie, Sync_Cookie *refcookie) { /* client and server info must match */ if ((testcookie && refcookie) && (strcmp(testcookie->cookie_client_signature, refcookie->cookie_client_signature) || strcmp(testcookie->cookie_server_signature, refcookie->cookie_server_signature) || testcookie->cookie_change_info == -1 || testcookie->cookie_change_info > refcookie->cookie_change_info)) { return (0); } /* could add an additional check if the requested state in client cookie is still * available. Accept any state request for now. */ return (1); } void sync_cookie_free(Sync_Cookie **freecookie) { if (*freecookie) { slapi_ch_free((void **)&((*freecookie)->cookie_client_signature)); slapi_ch_free((void **)&((*freecookie)->cookie_server_signature)); slapi_ch_free((void **)freecookie); } } int sync_is_active_scope(const Slapi_DN *dn, Slapi_PBlock *pb) { int rc; char *origbase = NULL; Slapi_DN *base = NULL; int scope; slapi_pblock_get(pb, SLAPI_ORIGINAL_TARGET_DN, &origbase); slapi_pblock_get(pb, SLAPI_SEARCH_TARGET_SDN, &base); slapi_pblock_get(pb, SLAPI_SEARCH_SCOPE, &scope); if (NULL == base) { base = slapi_sdn_new_dn_byref(origbase); slapi_pblock_set(pb, SLAPI_SEARCH_TARGET_SDN, base); } if (slapi_sdn_scope_test(dn, base, scope)) { rc = 1; } else { rc = 0; } return (rc); } int sync_is_active(Slapi_Entry *e, Slapi_PBlock *pb) { if (pb == NULL) { /* not yet initialized */ return (0); } else { /* check id entry is in scope of sync request */ return (sync_is_active_scope(slapi_entry_get_sdn_const(e), pb)); } } Slapi_PBlock * sync_pblock_copy(Slapi_PBlock *src) { Slapi_Operation *operation; Slapi_Operation *operation_new; Slapi_Connection *connection; int *scope; int *deref; int *filter_normalized; char *fstr; char **attrs, **attrs_dup; char **reqattrs, **reqattrs_dup; int *attrsonly; int *isroot; int *sizelimit; int *timelimit; struct slapdplugin *pi; ber_int_t msgid; ber_tag_t tag; slapi_pblock_get(src, SLAPI_OPERATION, &operation); slapi_pblock_get(src, SLAPI_CONNECTION, &connection); slapi_pblock_get(src, SLAPI_SEARCH_SCOPE, &scope); slapi_pblock_get(src, SLAPI_SEARCH_DEREF, &deref); slapi_pblock_get(src, SLAPI_PLUGIN_SYNTAX_FILTER_NORMALIZED, &filter_normalized); slapi_pblock_get(src, SLAPI_SEARCH_STRFILTER, &fstr); slapi_pblock_get(src, SLAPI_SEARCH_ATTRS, &attrs); slapi_pblock_get(src, SLAPI_SEARCH_REQATTRS, &reqattrs); slapi_pblock_get(src, SLAPI_SEARCH_ATTRSONLY, &attrsonly); slapi_pblock_get(src, SLAPI_REQUESTOR_ISROOT, &isroot); slapi_pblock_get(src, SLAPI_SEARCH_SIZELIMIT, &sizelimit); slapi_pblock_get(src, SLAPI_SEARCH_TIMELIMIT, &timelimit); slapi_pblock_get(src, SLAPI_PLUGIN, &pi); Slapi_PBlock *dest = slapi_pblock_new(); operation_new = slapi_operation_new(0); msgid = slapi_operation_get_msgid(operation); slapi_operation_set_msgid(operation_new, msgid); tag = slapi_operation_get_tag(operation); slapi_operation_set_tag(operation_new, tag); slapi_pblock_set(dest, SLAPI_OPERATION, operation_new); slapi_pblock_set(dest, SLAPI_CONNECTION, connection); slapi_pblock_set(dest, SLAPI_SEARCH_SCOPE, &scope); slapi_pblock_set(dest, SLAPI_SEARCH_DEREF, &deref); slapi_pblock_set(dest, SLAPI_PLUGIN_SYNTAX_FILTER_NORMALIZED, &filter_normalized); slapi_pblock_set(dest, SLAPI_SEARCH_STRFILTER, slapi_ch_strdup(fstr)); attrs_dup = slapi_ch_array_dup(attrs); reqattrs_dup = slapi_ch_array_dup(reqattrs); slapi_pblock_set(dest, SLAPI_SEARCH_ATTRS, attrs_dup); slapi_pblock_set(dest, SLAPI_SEARCH_REQATTRS, reqattrs_dup); slapi_pblock_set(dest, SLAPI_SEARCH_ATTRSONLY, &attrsonly); slapi_pblock_set(dest, SLAPI_REQUESTOR_ISROOT, &isroot); slapi_pblock_set(dest, SLAPI_SEARCH_SIZELIMIT, &sizelimit); slapi_pblock_set(dest, SLAPI_SEARCH_TIMELIMIT, &timelimit); slapi_pblock_set(dest, SLAPI_PLUGIN, pi); return dest; } int sync_number2int(char *chgnrstr) { char *end; int nr; nr = (int)strtoul(chgnrstr, &end, 10); if (*end == '\0') { return (nr); } else { return (-1); } } unsigned long sync_number2ulong(char *chgnrstr) { char *end; unsigned long nr; nr = strtoul(chgnrstr, &end, 10); if (*end == '\0') { return (nr); } else { return SYNC_INVALID_CHANGENUM; } }