aranya-client.h

Go to the documentation of this file.

/*
 * Copyright (c) SpiderOak, Inc. All rights reserved.
 */
#ifndef ARANYA_H
#define ARANYA_H
 
#pragma once
 
/* Code generated by `capi`. DO NOT EDIT. */
 
#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>
#include <sys/socket.h>
 
#ifndef __has_attribute
    #define __has_attribute(x) 0
#endif /* __has_attribute */
 
#if !defined(ARANYA_ALIGNED)
    #if __has_attribute(aligned)
        #define ARANYA_ALIGNED(n) __attribute__((aligned(n)))
    #else
        #error "compiler must support `aligned` attribute"
    #endif
#endif /* ARANYA_ALIGNED */
 
#if !defined(ARANYA_DESIGNATED_INIT)
    #if __has_attribute(designated_init)
        #define ARANYA_DESIGNATED_INIT __attribute__((designated_init))
    #else
        #define ARANYA_DESIGNATED_INIT
    #endif
#endif /* ARANYA_DESIGNATED_INIT */
 
#if !defined(ARANYA_MUST_USE)
    #if __has_attribute(warn_unused_result)
        #define ARANYA_MUST_USE __attribute__((warn_unused_result))
    #else
        #define ARANYA_MUST_USE
    #endif
#endif /* ARANYA_MUST_USE */
 
#if !defined(ARANYA_NO_RETURN)
    #if __has_attribute(noreturn)
        #define ARANYA_NO_RETURN __attribute__((noreturn))
    #else
        #define ARANYA_NO_RETURN
    #endif
#endif /* ARANYA_NO_RETURN */
 
#if !defined(ARANYA_NON_NULL)
    #if defined(__gnu__)
        #if __has_attribute(nonnull)
            #define ARANYA_NON_NULL __attribute__((nonnull))
        #endif
    #elif defined(__clang__)
        #define ARANYA_NON_NULL _Nonnull
    #else
        #define ARANYA_NON_NULL
    #endif
#endif /* ARANYA_NON_NULL */
 
#if !defined(ARANYA_PACKED)
    #if __has_attribute(packed)
        #define ARANYA_PACKED __attribute__((packed))
    #else
        #define ARANYA_PACKED
    #endif
#endif /* ARANYA_PACKED */
 
 
#define ARANYA_DURATION_SECONDS (1000 * ARANYA_DURATION_MILLISECONDS)
 
#define ARANYA_DURATION_MILLISECONDS (1000 * ARANYA_DURATION_MICROSECONDS)
 
#define ARANYA_DURATION_MICROSECONDS (1000 * ARANYA_DURATION_NANOSECONDS)
 
#define ARANYA_DURATION_NANOSECONDS 1
 
enum AranyaError
#ifdef __cplusplus
  : uint32_t
#endif // __cplusplus
 {
    ARANYA_ERROR_SUCCESS,
    ARANYA_ERROR_BUG,
    ARANYA_ERROR_TIMEOUT,
    ARANYA_ERROR_LOG_INIT,
    ARANYA_ERROR_INVALID_ARGUMENT,
    ARANYA_ERROR_BUFFER_TOO_SMALL,
    ARANYA_ERROR_INVALID_UTF8,
    ARANYA_ERROR_INVALID_ADDR,
    ARANYA_ERROR_CONNECTING,
    ARANYA_ERROR_AFC_ROUTER,
    ARANYA_ERROR_RPC,
    ARANYA_ERROR_DAEMON,
    ARANYA_ERROR_AFC_SHM,
    ARANYA_ERROR_AFC,
    ARANYA_ERROR_RUNTIME,
};
#ifndef __cplusplus
typedef uint32_t AranyaError;
#endif // __cplusplus
 
enum AranyaRole
#ifdef __cplusplus
  : uint8_t
#endif // __cplusplus
 {
    ARANYA_ROLE_OWNER,
    ARANYA_ROLE_ADMIN,
    ARANYA_ROLE_OPERATOR,
    ARANYA_ROLE_MEMBER,
};
#ifndef __cplusplus
typedef uint8_t AranyaRole;
#endif // __cplusplus
 
typedef struct ARANYA_ALIGNED(8) AranyaExtError {
    uint8_t __for_size_only[72];
} AranyaExtError;
 
typedef struct ARANYA_ALIGNED(16) AranyaClient {
    uint8_t __for_size_only[2624];
} AranyaClient;
 
typedef struct ARANYA_DESIGNATED_INIT AranyaAfcConfig {
    const char *shm_path;
    size_t max_channels;
    const char *addr;
} AranyaAfcConfig;
 
typedef struct ARANYA_DESIGNATED_INIT AranyaClientConfig {
    const char *daemon_sock;
    struct AranyaAfcConfig afc;
} AranyaClientConfig;
 
typedef struct ARANYA_DESIGNATED_INIT AranyaKeyBundle {
    const uint8_t *ident_key;
    size_t ident_key_len;
    const uint8_t *sign_key;
    size_t sign_key_len;
    const uint8_t *enc_key;
    size_t enc_key_len;
} AranyaKeyBundle;
 
typedef struct ARANYA_ALIGNED(1) AranyaDeviceId {
    uint8_t __for_size_only[64];
} AranyaDeviceId;
 
typedef struct ARANYA_ALIGNED(1) AranyaTeamId {
    uint8_t __for_size_only[64];
} AranyaTeamId;
 
typedef const char *AranyaAddr;
 
typedef uint64_t AranyaDuration;
 
typedef const char *AranyaNetIdentifier;
 
typedef uint32_t AranyaLabel;
 
typedef struct ARANYA_ALIGNED(1) AranyaChannelId {
    uint8_t __for_size_only[16];
} AranyaChannelId;
 
typedef struct sockaddr_storage AranyaSocketAddr;
 
typedef struct AranyaAfcMsgInfo {
    struct AranyaChannelId channel;
    AranyaLabel label;
    AranyaSocketAddr addr;
} AranyaAfcMsgInfo;
 
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
 
const char *aranya_error_to_str(uint32_t err);
 
AranyaError aranya_ext_error_init(struct AranyaExtError *out);
 
AranyaError aranya_ext_error_init_ext(struct AranyaExtError *out,
                                      struct AranyaExtError *__ext_err);
 
AranyaError aranya_ext_error_cleanup(struct AranyaExtError *ptr);
 
AranyaError aranya_ext_error_cleanup_ext(struct AranyaExtError *ptr,
                                         struct AranyaExtError *__ext_err);
 
AranyaError aranya_ext_error_msg(const struct AranyaExtError *err,
                                 char *msg,
                                 size_t *msg_len);
 
AranyaError aranya_ext_error_msg_ext(const struct AranyaExtError *err,
                                     char *msg,
                                     size_t *msg_len,
                                     struct AranyaExtError *__ext_err);
 
AranyaError aranya_init_logging(void);
 
AranyaError aranya_init_logging_ext(struct AranyaExtError *__ext_err);
 
AranyaError aranya_client_cleanup(struct AranyaClient *ptr);
 
AranyaError aranya_client_cleanup_ext(struct AranyaClient *ptr,
                                      struct AranyaExtError *__ext_err);
 
AranyaError aranya_client_init(struct AranyaClient *client,
                               const struct AranyaClientConfig *config);
 
AranyaError aranya_client_init_ext(struct AranyaClient *client,
                                   const struct AranyaClientConfig *config,
                                   struct AranyaExtError *__ext_err);
 
AranyaError aranya_get_key_bundle(struct AranyaClient *client,
                                  struct AranyaKeyBundle *__output);
 
AranyaError aranya_get_key_bundle_ext(struct AranyaClient *client,
                                      struct AranyaKeyBundle *__output,
                                      struct AranyaExtError *__ext_err);
 
AranyaError aranya_get_device_id(struct AranyaClient *client,
                                 struct AranyaDeviceId *__output);
 
AranyaError aranya_get_device_id_ext(struct AranyaClient *client,
                                     struct AranyaDeviceId *__output,
                                     struct AranyaExtError *__ext_err);
 
AranyaError aranya_create_team(struct AranyaClient *client,
                               struct AranyaTeamId *__output);
 
AranyaError aranya_create_team_ext(struct AranyaClient *client,
                                   struct AranyaTeamId *__output,
                                   struct AranyaExtError *__ext_err);
 
AranyaError aranya_add_team(struct AranyaClient *client,
                            const struct AranyaTeamId *team);
 
AranyaError aranya_add_team_ext(struct AranyaClient *client,
                                const struct AranyaTeamId *team,
                                struct AranyaExtError *__ext_err);
 
AranyaError aranya_remove_team(struct AranyaClient *client,
                               const struct AranyaTeamId *team);
 
AranyaError aranya_remove_team_ext(struct AranyaClient *client,
                                   const struct AranyaTeamId *team,
                                   struct AranyaExtError *__ext_err);
 
AranyaError aranya_add_sync_peer(struct AranyaClient *client,
                                 const struct AranyaTeamId *team,
                                 AranyaAddr addr,
                                 AranyaDuration interval);
 
AranyaError aranya_add_sync_peer_ext(struct AranyaClient *client,
                                     const struct AranyaTeamId *team,
                                     AranyaAddr addr,
                                     AranyaDuration interval,
                                     struct AranyaExtError *__ext_err);
 
AranyaError aranya_remove_sync_peer(struct AranyaClient *client,
                                    const struct AranyaTeamId *team,
                                    AranyaAddr addr);
 
AranyaError aranya_remove_sync_peer_ext(struct AranyaClient *client,
                                        const struct AranyaTeamId *team,
                                        AranyaAddr addr,
                                        struct AranyaExtError *__ext_err);
 
AranyaError aranya_close_team(struct AranyaClient *client,
                              const struct AranyaTeamId *team);
 
AranyaError aranya_close_team_ext(struct AranyaClient *client,
                                  const struct AranyaTeamId *team,
                                  struct AranyaExtError *__ext_err);
 
AranyaError aranya_add_device_to_team(struct AranyaClient *client,
                                      const struct AranyaTeamId *team,
                                      const struct AranyaKeyBundle *keys);
 
AranyaError aranya_add_device_to_team_ext(struct AranyaClient *client,
                                          const struct AranyaTeamId *team,
                                          const struct AranyaKeyBundle *keys,
                                          struct AranyaExtError *__ext_err);
 
AranyaError aranya_remove_device_from_team(struct AranyaClient *client,
                                           const struct AranyaTeamId *team,
                                           const struct AranyaDeviceId *device);
 
AranyaError aranya_remove_device_from_team_ext(struct AranyaClient *client,
                                               const struct AranyaTeamId *team,
                                               const struct AranyaDeviceId *device,
                                               struct AranyaExtError *__ext_err);
 
AranyaError aranya_assign_role(struct AranyaClient *client,
                               const struct AranyaTeamId *team,
                               const struct AranyaDeviceId *device,
                               AranyaRole role);
 
AranyaError aranya_assign_role_ext(struct AranyaClient *client,
                                   const struct AranyaTeamId *team,
                                   const struct AranyaDeviceId *device,
                                   AranyaRole role,
                                   struct AranyaExtError *__ext_err);
 
AranyaError aranya_revoke_role(struct AranyaClient *client,
                               const struct AranyaTeamId *team,
                               const struct AranyaDeviceId *device,
                               AranyaRole role);
 
AranyaError aranya_revoke_role_ext(struct AranyaClient *client,
                                   const struct AranyaTeamId *team,
                                   const struct AranyaDeviceId *device,
                                   AranyaRole role,
                                   struct AranyaExtError *__ext_err);
 
AranyaError aranya_assign_net_identifier(struct AranyaClient *client,
                                         const struct AranyaTeamId *team,
                                         const struct AranyaDeviceId *device,
                                         AranyaNetIdentifier net_identifier);
 
AranyaError aranya_assign_net_identifier_ext(struct AranyaClient *client,
                                             const struct AranyaTeamId *team,
                                             const struct AranyaDeviceId *device,
                                             AranyaNetIdentifier net_identifier,
                                             struct AranyaExtError *__ext_err);
 
AranyaError aranya_remove_net_identifier(struct AranyaClient *client,
                                         const struct AranyaTeamId *team,
                                         const struct AranyaDeviceId *device,
                                         AranyaNetIdentifier net_identifier);
 
AranyaError aranya_remove_net_identifier_ext(struct AranyaClient *client,
                                             const struct AranyaTeamId *team,
                                             const struct AranyaDeviceId *device,
                                             AranyaNetIdentifier net_identifier,
                                             struct AranyaExtError *__ext_err);
 
AranyaError aranya_create_label(struct AranyaClient *client,
                                const struct AranyaTeamId *team,
                                AranyaLabel label);
 
AranyaError aranya_create_label_ext(struct AranyaClient *client,
                                    const struct AranyaTeamId *team,
                                    AranyaLabel label,
                                    struct AranyaExtError *__ext_err);
 
AranyaError aranya_delete_label(struct AranyaClient *client,
                                const struct AranyaTeamId *team,
                                AranyaLabel label);
 
AranyaError aranya_delete_label_ext(struct AranyaClient *client,
                                    const struct AranyaTeamId *team,
                                    AranyaLabel label,
                                    struct AranyaExtError *__ext_err);
 
AranyaError aranya_assign_label(struct AranyaClient *client,
                                const struct AranyaTeamId *team,
                                const struct AranyaDeviceId *device,
                                AranyaLabel label);
 
AranyaError aranya_assign_label_ext(struct AranyaClient *client,
                                    const struct AranyaTeamId *team,
                                    const struct AranyaDeviceId *device,
                                    AranyaLabel label,
                                    struct AranyaExtError *__ext_err);
 
AranyaError aranya_revoke_label(struct AranyaClient *client,
                                const struct AranyaTeamId *team,
                                const struct AranyaDeviceId *device,
                                AranyaLabel label);
 
AranyaError aranya_revoke_label_ext(struct AranyaClient *client,
                                    const struct AranyaTeamId *team,
                                    const struct AranyaDeviceId *device,
                                    AranyaLabel label,
                                    struct AranyaExtError *__ext_err);
 
AranyaError aranya_create_bidi_channel(struct AranyaClient *client,
                                       const struct AranyaTeamId *team,
                                       AranyaNetIdentifier peer,
                                       AranyaLabel label,
                                       struct AranyaChannelId *__output);
 
AranyaError aranya_create_bidi_channel_ext(struct AranyaClient *client,
                                           const struct AranyaTeamId *team,
                                           AranyaNetIdentifier peer,
                                           AranyaLabel label,
                                           struct AranyaChannelId *__output,
                                           struct AranyaExtError *__ext_err);
 
AranyaError aranya_delete_channel(struct AranyaClient *client,
                                  struct AranyaChannelId chan);
 
AranyaError aranya_delete_channel_ext(struct AranyaClient *client,
                                      struct AranyaChannelId chan,
                                      struct AranyaExtError *__ext_err);
 
AranyaError aranya_poll_data(struct AranyaClient *client,
                             AranyaDuration timeout);
 
AranyaError aranya_poll_data_ext(struct AranyaClient *client,
                                 AranyaDuration timeout,
                                 struct AranyaExtError *__ext_err);
 
AranyaError aranya_send_data(struct AranyaClient *client,
                             struct AranyaChannelId chan,
                             const uint8_t *data,
                             size_t data_len);
 
AranyaError aranya_send_data_ext(struct AranyaClient *client,
                                 struct AranyaChannelId chan,
                                 const uint8_t *data,
                                 size_t data_len,
                                 struct AranyaExtError *__ext_err);
 
AranyaError aranya_recv_data(struct AranyaClient *client,
                             uint8_t *buf,
                             size_t *buf_len,
                             struct AranyaAfcMsgInfo *info);
 
AranyaError aranya_recv_data_ext(struct AranyaClient *client,
                                 uint8_t *buf,
                                 size_t *buf_len,
                                 struct AranyaAfcMsgInfo *info,
                                 struct AranyaExtError *__ext_err);
 
#ifdef __cplusplus
}  // extern "C"
#endif  // __cplusplus
 
#endif  /* ARANYA_H */