auth.h

Go to the documentation of this file.

/* -*- Mode: C; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
/*
 *     Copyright 2017-2020 Couchbase, Inc.
 *
 *   Licensed under the Apache License, Version 2.0 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *   limitations under the License.
 */

#ifndef LCB_AUTH_H
#define LCB_AUTH_H

#ifdef __cplusplus
namespace lcb
{
class Authenticator;
}
typedef lcb::Authenticator lcb_AUTHENTICATOR;
extern "C" {
#else /* C only! */
typedef struct lcb_AUTHENTICATOR_Cdummy lcb_AUTHENTICATOR;
#endif

LIBCOUCHBASE_API
lcb_AUTHENTICATOR *lcbauth_new(void);

typedef enum {
    LCBAUTH_F_CLUSTER = 1 << 1,

    LCBAUTH_F_BUCKET = 1 << 2
} lcbauth_ADDPASSFLAGS;

LIBCOUCHBASE_API
lcb_STATUS lcbauth_add_pass(lcb_AUTHENTICATOR *auth, const char *user, const char *pass, int flags);

LIBCOUCHBASE_API
void lcbauth_ref(lcb_AUTHENTICATOR *auth);

LIBCOUCHBASE_API
void lcbauth_unref(lcb_AUTHENTICATOR *auth);

LIBCOUCHBASE_API
lcb_AUTHENTICATOR *lcbauth_clone(const lcb_AUTHENTICATOR *src);

typedef const char *(*lcb_AUTHCALLBACK)(void *cookie, const char *host, const char *port, const char *bucket);

LCB_DEPRECATED2(LIBCOUCHBASE_API lcb_STATUS lcbauth_set_callbacks(lcb_AUTHENTICATOR *auth, void *cookie,
                                                                  lcb_AUTHCALLBACK usercb, lcb_AUTHCALLBACK passcb),
                "Use lcbauth_set_callback");

typedef struct lcbauth_CREDENTIALS_ lcbauth_CREDENTIALS;

LIBCOUCHBASE_API lcb_STATUS lcbauth_credentials_username(lcbauth_CREDENTIALS *credentials, const char *username,
                                                         size_t username_len);
LIBCOUCHBASE_API lcb_STATUS lcbauth_credentials_password(lcbauth_CREDENTIALS *credentials, const char *password,
                                                         size_t password_len);

typedef enum {
    LCBAUTH_RESULT_OK = 0,
    LCBAUTH_RESULT_NOT_AVAILABLE,
} lcbauth_RESULT;

LIBCOUCHBASE_API lcb_STATUS lcbauth_credentials_result(lcbauth_CREDENTIALS *credentials, lcbauth_RESULT result);

typedef enum {
    LCBAUTH_SERVICE_UNSPECIFIED = 0,
    LCBAUTH_SERVICE_KEY_VALUE,
    LCBAUTH_SERVICE_QUERY,
    LCBAUTH_SERVICE_SEARCH,
    LCBAUTH_SERVICE_ANALYTICS,
    LCBAUTH_SERVICE_MANAGEMENT,
    LCBAUTH_SERVICE_EVENTING,
    LCBAUTH_SERVICE_VIEWS,
} lcbauth_SERVICE;

LIBCOUCHBASE_API lcbauth_SERVICE lcbauth_credentials_service(const lcbauth_CREDENTIALS *credentials);

typedef enum {
    LCBAUTH_REASON_NEW_OPERATION = 0,
    LCBAUTH_REASON_AUTHENTICATION_FAILURE,
} lcbauth_REASON;

LIBCOUCHBASE_API lcbauth_REASON lcbauth_credentials_reason(const lcbauth_CREDENTIALS *credentials);

LIBCOUCHBASE_API lcb_STATUS lcbauth_credentials_hostname(const lcbauth_CREDENTIALS *credentials, const char **hostname,
                                                         size_t *hostname_len);

LIBCOUCHBASE_API lcb_STATUS lcbauth_credentials_port(const lcbauth_CREDENTIALS *credentials, const char **port,
                                                     size_t *port_len);

LIBCOUCHBASE_API lcb_STATUS lcbauth_credentials_bucket(const lcbauth_CREDENTIALS *credentials, const char **bucket,
                                                       size_t *bucket_len);
LIBCOUCHBASE_API lcb_STATUS lcbauth_credentials_cookie(const lcbauth_CREDENTIALS *credentials, void **cookie);

LIBCOUCHBASE_API lcb_STATUS lcbauth_set_callback(lcb_AUTHENTICATOR *auth, void *cookie,
                                                 void (*callback)(lcbauth_CREDENTIALS *));

typedef enum {
    LCBAUTH_MODE_CLASSIC = 0,

    LCBAUTH_MODE_RBAC = 1,

    LCBAUTH_MODE_DYNAMIC = 2
} lcbauth_MODE;

LIBCOUCHBASE_API
lcb_STATUS lcbauth_set_mode(lcb_AUTHENTICATOR *src, lcbauth_MODE mode);

#ifdef __cplusplus
}
#endif
#endif /* LCB_AUTH_H */