Botan::PCurve::PrimeOrderCurveId Class Reference

Identifier for a named prime order curve. More...

#include <pcurves_id.h>

Public Types
enum class	Code : uint8_t {   secp256r1 , secp384r1 , secp521r1 , secp256k1 ,   brainpool256r1 , brainpool384r1 , brainpool512r1 , frp256v1 ,   sm2p256v1 }

Public Member Functions
Code	code () const
	PrimeOrderCurveId (Code id)
std::string	to_string () const
	Convert the ID to it's commonly used name (inverse of from_string)

Static Public Member Functions
static std::vector< PrimeOrderCurveId >	all ()
static std::optional< PrimeOrderCurveId >	from_string (std::string_view name)
	Map a string to a curve identifier.

Detailed Description

Identifier for a named prime order curve.

Definition at line 27 of file pcurves_id.h.

Member Enumeration Documentation

Code

enum class Botan::PCurve::PrimeOrderCurveId::Code : uint8_t

strong

Enumerator
secp256r1	secp256r1 aka P-256
secp384r1	secp384r1 aka P-384
secp521r1	secp521r1 aka P-521
secp256k1	secp256k1
brainpool256r1	brainpool256r1
brainpool384r1
brainpool512r1
frp256v1
sm2p256v1

Definition at line 29 of file pcurves_id.h.

                      : uint8_t {
         /// secp256r1 aka P-256
         secp256r1,
         /// secp384r1 aka P-384
         secp384r1,
         /// secp521r1 aka P-521
         secp521r1,
         /// secp256k1
         secp256k1,
         /// brainpool256r1
         brainpool256r1,
         brainpool384r1,
         brainpool512r1,
         frp256v1,
         sm2p256v1,
      };

Constructor & Destructor Documentation

PrimeOrderCurveId()

Botan::PCurve::PrimeOrderCurveId::PrimeOrderCurveId ( Code id )

inline

Definition at line 59 of file pcurves_id.h.

: m_code(id) {}

Member Function Documentation

all()

std::vector< PrimeOrderCurveId > Botan::PCurve::PrimeOrderCurveId::all ( )

static

Return a list of all of the defined PrimeOrderCurveId

Note this list always includes all curves, even if some were disabled at build time.

Definition at line 104 of file pcurves.cpp.

                                                    {
   return {
      PrimeOrderCurveId::secp256r1,
      PrimeOrderCurveId::secp384r1,
      PrimeOrderCurveId::secp521r1,
      PrimeOrderCurveId::secp256k1,
      PrimeOrderCurveId::brainpool256r1,
      PrimeOrderCurveId::brainpool384r1,
      PrimeOrderCurveId::brainpool512r1,
      PrimeOrderCurveId::frp256v1,
      PrimeOrderCurveId::sm2p256v1,
   };
}

References brainpool256r1, brainpool384r1, brainpool512r1, frp256v1, secp256k1, secp256r1, secp384r1, secp521r1, and sm2p256v1.

code()

Code Botan::PCurve::PrimeOrderCurveId::code ( ) const

inline

Definition at line 48 of file pcurves_id.h.

{ return m_code; }

Referenced by to_string().

from_string()

std::optional< PrimeOrderCurveId > Botan::PCurve::PrimeOrderCurveId::from_string ( std::string_view name )

static

Map a string to a curve identifier.

Definition at line 144 of file pcurves.cpp.

                                                                                 {
   if(name == "secp256r1") {
      return PCurve::PrimeOrderCurveId::secp256r1;
   } else if(name == "secp384r1") {
      return PCurve::PrimeOrderCurveId::secp384r1;
   } else if(name == "secp521r1") {
      return PCurve::PrimeOrderCurveId::secp521r1;
   } else if(name == "secp256k1") {
      return PCurve::PrimeOrderCurveId::secp256k1;
   } else if(name == "brainpool256r1") {
      return PCurve::PrimeOrderCurveId::brainpool256r1;
   } else if(name == "brainpool384r1") {
      return PCurve::PrimeOrderCurveId::brainpool384r1;
   } else if(name == "brainpool512r1") {
      return PCurve::PrimeOrderCurveId::brainpool512r1;
   } else if(name == "frp256v1") {
      return PCurve::PrimeOrderCurveId::frp256v1;
   } else if(name == "sm2p256v1") {
      return PCurve::PrimeOrderCurveId::sm2p256v1;
   } else {
      return {};
   }
}

References brainpool256r1, brainpool384r1, brainpool512r1, frp256v1, name, secp256k1, secp256r1, secp384r1, secp521r1, and sm2p256v1.

to_string()

std::string Botan::PCurve::PrimeOrderCurveId::to_string

(

)

const

Convert the ID to it's commonly used name (inverse of from_string)

Definition at line 118 of file pcurves.cpp.

                                             {
   switch(this->code()) {
      case PrimeOrderCurveId::secp256r1:
         return "secp256r1";
      case PrimeOrderCurveId::secp384r1:
         return "secp384r1";
      case PrimeOrderCurveId::secp521r1:
         return "secp521r1";
      case PrimeOrderCurveId::secp256k1:
         return "secp256k1";
      case PrimeOrderCurveId::brainpool256r1:
         return "brainpool256r1";
      case PrimeOrderCurveId::brainpool384r1:
         return "brainpool384r1";
      case PrimeOrderCurveId::brainpool512r1:
         return "brainpool512r1";
      case PrimeOrderCurveId::frp256v1:
         return "frp256v1";
      case PrimeOrderCurveId::sm2p256v1:
         return "sm2p256v1";
   }
 
   return "unknown";
}

References brainpool256r1, brainpool384r1, brainpool512r1, code(), frp256v1, secp256k1, secp256r1, secp384r1, secp521r1, and sm2p256v1.

---

The documentation for this class was generated from the following files:

• src/lib/math/pcurves/pcurves_id.h
• src/lib/math/pcurves/pcurves.cpp