GDCredentialsProfile.h

Go to the documentation of this file.

/*
 * Copyright 2023 BlackBerry Limited. All rights reserved.
 */
 
#ifndef GD_CREDENTIALS_PROFILE_H
#define GD_CREDENTIALS_PROFILE_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifndef GD_C_API
#   if !defined(_WIN32)
#       define GD_C_API __attribute__((visibility("default")))
#   else
#       define GD_C_API
#   endif
#endif
 
#include "GDCommon.h"
 
struct GDError;
 
typedef enum {
    GDCredentialsProfileStateImportDue,
 
    GDCredentialsProfileStateImportNow,
 
    GDCredentialsProfileStateImported,
 
    GDCredentialsProfileStateModified,
 
    GDCredentialsProfileStateRenewalDue,
 
    GDCredentialsProfileStateDeleted
} GD_C_API GDCredentialsProfileState;
 
struct GD_C_API GDCredentialsProfile {
    char* id;
 
    GDCredentialsProfileState state;
 
    char* type;
 
    char* name;
 
    bool required;
 
    char* providerSettings;
};
 
typedef enum {
    GDCredentialsProfileTypeUnknown,
 
    GDCredentialsProfileTypeAppbased,
 
    GDCredentialsProfileTypeDeviceKeystore,
 
    GDCredentialsProfileTypeUserCertificate,
 
    GDCredentialsProfileTypeAssistedSCEP,
 
    GDCredentialsProfileTypeEntrust,
 
    GDCredentialsProfileTypePKIConnector
 
} GD_C_API GDCredentialsProfileType;
 
GD_C_API GDCredentialsProfileType GDCredentialsProfile_type(const char* profileId);
 
struct GD_C_API GDCredentialsProfileEvent {
    struct GDCredentialsProfile* profile;
};
 
typedef void (*GDCredentialsProfileEventCb)(const struct GDCredentialsProfileEvent event, void* appData);
 
GD_C_API void GDCredentialsProfile_register(GDCredentialsProfileEventCb cb, void* appData);
 
GD_C_API void GDCredentialsProfile_register_type(GDCredentialsProfileType type, GDCredentialsProfileEventCb cb, void* appData);
 
GD_C_API bool GDCredentialsProfile_is_type_registered(GDCredentialsProfileType type);
 
GD_C_API bool GDCredentialsProfile_list(size_t* profileCount,
                                        struct GDCredentialsProfile** profiles,
                                        struct GDError* error);
 
GD_C_API int GDCredentialsProfile_days_until_expiry(const char* profileId);
 
GD_C_API int GDCredentialsProfile_days_until_renewal_due(const char* profileId);
 
GD_C_API void GDCredentialsProfile_begin_enrolment(const char* profileId);
 
GD_C_API void GDCredentialsProfile_begin_enrolment_type(GDCredentialsProfileType type);
 
GD_C_API bool GDCredentialsProfile_can_reset_type(GDCredentialsProfileType type);
 
GD_C_API void GDCredentialsProfile_reset_type(GDCredentialsProfileType type);
 
GD_C_API void GDCredentialsProfile_free(struct GDCredentialsProfile* profiles,
                                        size_t profileCount);
 
GD_C_API void GDCredentialsProfile_unregister(void);
 
GD_C_API void GDCredentialsProfile_unregister_type(GDCredentialsProfileType type);
 
#ifdef __cplusplus
}
#endif
 
#endif