openvas-krb5.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2025 Greenbone AG
//
// SPDX-License-Identifier: GPL-2.0-or-later WITH x11vnc-openssl-exception
 
#ifndef OPENVAS_KRB5
#define OPENVAS_KRB5 1
#include <stdbool.h>
#include <stddef.h>
// Enables or disables the cache implementation.
//
// When using the cached functions it will store each credential in a memory
// list and refresh a ticket when required or  reauthenticate depending on the
// requirements in the background.
#define OPENVAS_KRB5_CACHED 1
 
typedef enum
{
  O_KRB5_SUCCESS,
  // Is returned when the krb5.conf was not found
  O_KRB5_CONF_NOT_FOUND,
  O_KRB5_CONF_NOT_CREATED,
  O_KRB5_TMP_CONF_NOT_CREATED,
  O_KRB5_TMP_CONF_NOT_MOVED,
  O_KRB5_REALM_NOT_FOUND,
  O_KRB5_EXPECTED_NULL,
  O_KRB5_EXPECTED_NOT_NULL,
  O_KRB5_UNABLE_TO_WRITE,
  // can only happen when GFP_ATOMIC is set on the kernel.
  O_KRB5_NOMEM,
 
  // Is an transitive error code to indicate an error originating from the
  // underlying krb5 implementation. It must be last and can not check by equals
  // operation as each krb5 error return will be added with that number
  // representation,
  O_KRB5_ERROR,
} OKrb5ErrorCode;
 
struct OKrb5Slice
{
  void *data;
  size_t len;
};
 
struct OKrb5User
{
  struct OKrb5Slice user;
  struct OKrb5Slice password;
};
 
struct OKrb5Target
{
  struct OKrb5Slice host_name;
  struct OKrb5Slice service;
  struct OKrb5Slice domain;
};
 
typedef struct
{
  struct OKrb5Slice config_path;
  struct OKrb5Slice realm;
  // required for the case that the realm is not configured in the krb5.conf
  // will be ignored otherwise.
  struct OKrb5Slice kdc;
  struct OKrb5User user;
  struct OKrb5Target target;
} OKrb5Credential;
 
// Finds the kdc defined for the given realm.
//
// It returns the found kdc into `kdc` when `kdc` is not NULL.
// If kdc is not NULL it requires that the value pointer is NULL otherwise an
// error code is returned.
OKrb5ErrorCode
o_krb5_find_kdc (const OKrb5Credential *creds, char **kdc);
// Adds realm with the given kdc into krb5.conf if the krc5.conf is not found it
// will create a new one
OKrb5ErrorCode
o_krb5_add_realm (const OKrb5Credential *creds, const char *kdc);
 
#define okrb5_slice_from_str(str)                               \
  (struct OKrb5Slice)                                           \
  {                                                             \
    .data = (void *) str, .len = str == NULL ? 0 : strlen (str) \
  }
 
#define okrb5_set_slice_from_str(slice, str)      \
  do                                              \
    {                                             \
      slice.data = (void *) str;                  \
      slice.len = str == NULL ? 0 : strlen (str); \
    }                                             \
  while (0)
 
typedef struct OKrb5GSSContext OKrb5GSSContext;
// Unsure about bool type
 
OKrb5ErrorCode
o_krb5_gss_session_key_context (struct OKrb5GSSContext *gss_context,
                                struct OKrb5Slice **out);
 
struct OKrb5GSSContext *
okrb5_gss_init_context (void);
 
void
okrb5_gss_free_context (struct OKrb5GSSContext *context);
 
OKrb5ErrorCode
o_krb5_gss_prepare_context (const OKrb5Credential *creds,
                            struct OKrb5GSSContext *gss_context);
 
OKrb5ErrorCode
o_krb5_gss_update_context (struct OKrb5GSSContext *gss_context,
                           const struct OKrb5Slice *in_data,
                           struct OKrb5Slice **out_data, bool *more);
 
// Returns NULL if the error code is not found. The returned string must be
// freed by the caller.
char *
okrb5_error_code_to_string (const OKrb5ErrorCode code);
 
#endif