ffi_oid.cpp File Reference

#include <botan/ffi.h>
#include <botan/internal/ffi_oid.h>
#include <botan/internal/ffi_pkey.h>
#include <botan/internal/ffi_util.h>

Go to the source code of this file.

Functions
int	botan_oid_cmp (int *result, botan_asn1_oid_t a_w, botan_asn1_oid_t b_w)
int	botan_oid_destroy (botan_asn1_oid_t oid)
int	botan_oid_equal (botan_asn1_oid_t a_w, botan_asn1_oid_t b_w)
int	botan_oid_from_string (botan_asn1_oid_t *oid_obj, const char *oid_str)
int	botan_oid_register (botan_asn1_oid_t oid, const char *name)
int	botan_oid_view_name (botan_asn1_oid_t oid, botan_view_ctx ctx, botan_view_str_fn view)
int	botan_oid_view_string (botan_asn1_oid_t oid, botan_view_ctx ctx, botan_view_str_fn view)

Function Documentation

botan_oid_cmp()

int botan_oid_cmp	(	int *	result,
		botan_asn1_oid_t	a,
		botan_asn1_oid_t	b )

Sets

Parameters

result

to comparison result: -1 if a < b, 0 if a == b, 1 if a > b

Returns

negative number on error or zero on success

Definition at line 63 of file ffi_oid.cpp.

                                                                           {
   return BOTAN_FFI_VISIT(a_w, [=](auto& a) {
      if(result == nullptr) {
         return BOTAN_FFI_ERROR_NULL_POINTER;
      }
      const Botan::OID b = safe_get(b_w);
      // we don't have .cmp for OID
      if(a == b) {
         *result = 0;
      } else if(a < b) {
         *result = -1;
      } else {
         *result = 1;
      }
      return BOTAN_FFI_SUCCESS;
   });
}

References BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_FFI_VISIT, and Botan_FFI::safe_get().

botan_oid_destroy()

int botan_oid_destroy

(

botan_asn1_oid_t

oid

)

Frees all resources of the OID object

Parameters

oid	the OID object to destroy

Returns

negative number on error, or zero on success

Definition at line 18 of file ffi_oid.cpp.

                                            {
   return BOTAN_FFI_CHECKED_DELETE(oid);
}

References BOTAN_FFI_CHECKED_DELETE.

botan_oid_equal()

int botan_oid_equal	(	botan_asn1_oid_t	a,
		botan_asn1_oid_t	b )

Test if two OIDs are equal

Parameters

a	the first OID
b	the second OID

Returns

0 if a != b

1 if a == b

negative number on error

Definition at line 59 of file ffi_oid.cpp.

                                                                {
   return BOTAN_FFI_VISIT(a_w, [=](const auto& a) -> int { return a == safe_get(b_w); });
}

References BOTAN_FFI_VISIT, and Botan_FFI::safe_get().

botan_oid_from_string()

int botan_oid_from_string	(	botan_asn1_oid_t *	oid,
		const char *	oid_str )

Create an OID from a string, either dot notation (e.g. '1.2.3.4') or a registered name (e.g. 'RSA')

Parameters

oid	handle to the resulting OID
oid_str	the name of the OID to create

Returns

negative number on error, or zero on success

Definition at line 22 of file ffi_oid.cpp.

                                                                          {
   return ffi_guard_thunk(__func__, [=]() -> int {
      if(any_null_pointers(oid_obj, oid_str)) {
         return BOTAN_FFI_ERROR_NULL_POINTER;
      }
      Botan::OID oid;
      // This returns a Lookup_Error if an unknown name is passed,
      // which would get turned into NOT_IMPLEMENTED
      try {
         oid = Botan::OID::from_string(oid_str);
      } catch(Botan::Lookup_Error&) {
         return BOTAN_FFI_ERROR_BAD_PARAMETER;
      }
      auto oid_ptr = std::make_unique<Botan::OID>(std::move(oid));
      return ffi_new_object(oid_obj, std::move(oid_ptr));
   });
}

References Botan_FFI::any_null_pointers(), BOTAN_FFI_ERROR_BAD_PARAMETER, BOTAN_FFI_ERROR_NULL_POINTER, Botan_FFI::ffi_guard_thunk(), Botan_FFI::ffi_new_object(), and Botan::OID::from_string().

botan_oid_register()

int botan_oid_register	(	botan_asn1_oid_t	oid,
		const char *	name )

Registers an OID so that it may later be retrieved by name

Returns

negative number on error, or zero on success

Definition at line 40 of file ffi_oid.cpp.

                                                               {
   return BOTAN_FFI_VISIT(oid, [=](const auto& o) -> int {
      if(name == nullptr) {
         return BOTAN_FFI_ERROR_NULL_POINTER;
      }
      Botan::OID::register_oid(o, name);
      return BOTAN_FFI_SUCCESS;
   });
}

References BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_SUCCESS, BOTAN_FFI_VISIT, and Botan::OID::register_oid().

botan_oid_view_name()

int botan_oid_view_name	(	botan_asn1_oid_t	oid,
		botan_view_ctx	ctx,
		botan_view_str_fn	view )

View an OIDs registered name if it exists, else its dot notation

Definition at line 54 of file ffi_oid.cpp.

                                                                                          {
   return BOTAN_FFI_VISIT(
      oid, [=](const auto& o) -> int { return invoke_view_callback(view, ctx, o.to_formatted_string()); });
}

References BOTAN_FFI_VISIT, and Botan_FFI::invoke_view_callback().

botan_oid_view_string()

int botan_oid_view_string	(	botan_asn1_oid_t	oid,
		botan_view_ctx	ctx,
		botan_view_str_fn	view )

View an OID in dot notation

Definition at line 50 of file ffi_oid.cpp.

                                                                                            {
   return BOTAN_FFI_VISIT(oid, [=](const auto& o) -> int { return invoke_view_callback(view, ctx, o.to_string()); });
}

References BOTAN_FFI_VISIT, and Botan_FFI::invoke_view_callback().