123456789_123456789_123456789_123456789_123456789_

Class: OpenSSL::PKey::EC::Point

Relationships & Source Files
Namespace Children
Exceptions:
Error
Inherits: Object
Defined in: ext/openssl/ossl_pkey_ec.c,
ext/openssl/lib/openssl/pkey.rb

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(point) .new(group [, encoded_point])

Creates a new instance of Point. If the only argument is an instance of Point, a copy is returned. Otherwise, creates a point that belongs to group.

encoded_point is the octet string representation of the point. This must be either a String or an ::OpenSSL::BN.

[ GitHub ] 

  


# File 'ext/openssl/ossl_pkey_ec.c', line 1215



static VALUE ossl_ec_point_initialize(int argc, VALUE *argv, VALUE self)
{
    EC_POINT *point;
    VALUE group_v, arg2;
    const EC_GROUP *group;

    TypedData_Get_Struct(self, EC_POINT, &ossl_ec_point_type, point);
    if (point)
	rb_raise(eEC_POINT, "EC_POINT already initialized");

    rb_scan_args(argc, argv, "11", &group_v, &arg2);
    if (rb_obj_is_kind_of(group_v, cEC_POINT)) {
	if (argc != 1)
	    rb_raise(rb_eArgError, "invalid second argument");
	return ossl_ec_point_initialize_copy(self, group_v);
    }

    GetECGroup(group_v, group);
    if (argc == 1) {
	point = EC_POINT_new(group);
	if (!point)
	    ossl_raise(eEC_POINT, "EC_POINT_new");
    }
    else {
	if (rb_obj_is_kind_of(arg2, cBN)) {
	    point = EC_POINT_bn2point(group, GetBNPtr(arg2), NULL, ossl_bn_ctx);
	    if (!point)
		ossl_raise(eEC_POINT, "EC_POINT_bn2point");
	}
	else {
	    StringValue(arg2);
	    point = EC_POINT_new(group);
	    if (!point)
		ossl_raise(eEC_POINT, "EC_POINT_new");
	    if (!EC_POINT_oct2point(group, point,
				    (unsigned char *)RSTRING_PTR(arg2),
				    RSTRING_LEN(arg2), ossl_bn_ctx)) {
		EC_POINT_free(point);
		ossl_raise(eEC_POINT, "EC_POINT_oct2point");
	    }
	}
    }

    RTYPEDDATA_DATA(self) = point;
    rb_ivar_set(self, id_i_group, group_v);

    return self;
}


  







Instance Attribute Details



  

    #infinity?  ⇒ Boolean  (readonly)  

  [ GitHub ]


  

  


# File 'ext/openssl/ossl_pkey_ec.c', line 1320



static VALUE ossl_ec_point_is_at_infinity(VALUE self)
{
    EC_POINT *point;
    const EC_GROUP *group;

    GetECPoint(self, point);
    GetECPointGroup(self, group);

    switch (EC_POINT_is_at_infinity(group, point)) {
    case 1: return Qtrue;
    case 0: return Qfalse;
    default: ossl_raise(eEC_POINT, "EC_POINT_is_at_infinity");
    }

    UNREACHABLE;
}


  








  

    #on_curve?  ⇒ Boolean  (readonly)  

  [ GitHub ]


  

  


# File 'ext/openssl/ossl_pkey_ec.c', line 1341



static VALUE ossl_ec_point_is_on_curve(VALUE self)
{
    EC_POINT *point;
    const EC_GROUP *group;

    GetECPoint(self, point);
    GetECPointGroup(self, group);

    switch (EC_POINT_is_on_curve(group, point, ossl_bn_ctx)) {
    case 1: return Qtrue;
    case 0: return Qfalse;
    default: ossl_raise(eEC_POINT, "EC_POINT_is_on_curve");
    }

    UNREACHABLE;
}


  







Instance Method Details



  

    

      #eql?(point2)  ⇒ Boolean 
      #==(point2)  ⇒ Boolean 
    

    Also known as: #eql?
  



  

    
  



  [ GitHub ]


  

  


# File 'ext/openssl/ossl_pkey_ec.c', line 1293



static VALUE ossl_ec_point_eql(VALUE a, VALUE b)
{
    EC_POINT *point1, *point2;
    VALUE group_v1 = rb_attr_get(a, id_i_group);
    VALUE group_v2 = rb_attr_get(b, id_i_group);
    const EC_GROUP *group;

    if (ossl_ec_group_eql(group_v1, group_v2) == Qfalse)
        return Qfalse;

    GetECPoint(a, point1);
    GetECPoint(b, point2);
    GetECGroup(group_v1, group);

    switch (EC_POINT_cmp(group, point1, point2, ossl_bn_ctx)) {
    case 0: return Qtrue;
    case 1: return Qfalse;
    default: ossl_raise(eEC_POINT, "EC_POINT_cmp");
    }

    UNREACHABLE;
}


  








  

    #add(point)  ⇒ Point   



  

    

Performs elliptic curve point addition.


  



  [ GitHub ]


  

  


# File 'ext/openssl/ossl_pkey_ec.c', line 1459



static VALUE ossl_ec_point_add(VALUE self, VALUE other)
{
    EC_POINT *point_self, *point_other, *point_result;
    const EC_GROUP *group;
    VALUE group_v = rb_attr_get(self, id_i_group);
    VALUE result;

    GetECPoint(self, point_self);
    GetECPoint(other, point_other);
    GetECGroup(group_v, group);

    result = rb_obj_alloc(cEC_POINT);
    ossl_ec_point_initialize(1, &group_v, result);
    GetECPoint(result, point_result);

    if (EC_POINT_add(group, point_result, point_self, point_other, ossl_bn_ctx) != 1) {
        ossl_raise(eEC_POINT, "EC_POINT_add");
    }

    return result;
}


  








  

    

      #eql?(point2)  ⇒ Boolean 
      #==(point2)  ⇒ Boolean 
    

  



  

    

Alias for #==.


  





  








  

    #invert!  ⇒ self   



  

    
  



  [ GitHub ]


  

  


# File 'ext/openssl/ossl_pkey_ec.c', line 1385



static VALUE ossl_ec_point_invert(VALUE self)
{
    EC_POINT *point;
    const EC_GROUP *group;

    GetECPoint(self, point);
    GetECPointGroup(self, group);

    if (EC_POINT_invert(group, point, ossl_bn_ctx) != 1)
        ossl_raise(eEC_POINT, "EC_POINT_invert");

    return self;
}


  








  

    #make_affine!  ⇒ self   



  

    

This method is deprecated and should not be used. This is a no-op.


  



  [ GitHub ]


  

  


# File 'ext/openssl/ossl_pkey_ec.c', line 1364



static VALUE ossl_ec_point_make_affine(VALUE self)
{
    EC_POINT *point;
    const EC_GROUP *group;

    GetECPoint(self, point);
    GetECPointGroup(self, group);

    rb_warn("OpenSSL::PKey::EC::Point#make_affine! is deprecated");
#if !OSSL_OPENSSL_PREREQ(3, 0, 0) && !defined(OPENSSL_IS_AWSLC)
    if (EC_POINT_make_affine(group, point, ossl_bn_ctx) != 1)
        ossl_raise(eEC_POINT, "EC_POINT_make_affine");
#endif

    return self;
}


  








  

    #mul(bn1 [, bn2])  ⇒ Point   



  

    

Performs elliptic curve point multiplication.



The first form calculates bn1 * point + bn2 * G, where G is the generator of the group of point. bn2 may be omitted, and in that case, the result is just bn1 * point.



Before version 4.0.0, and when compiled with ::OpenSSL 1.1.1 or older, this method allowed another form:



point.mul(bns, points [, bn2]) => point


  



  [ GitHub ]


  

  


# File 'ext/openssl/ossl_pkey_ec.c', line 1495



static VALUE ossl_ec_point_mul(int argc, VALUE *argv, VALUE self)
{
    EC_POINT *point_self, *point_result;
    const EC_GROUP *group;
    VALUE group_v = rb_attr_get(self, id_i_group);
    VALUE arg1, arg2, arg3, result;
    const BIGNUM *bn_g = NULL;

    GetECPoint(self, point_self);
    GetECGroup(group_v, group);

    result = rb_obj_alloc(cEC_POINT);
    ossl_ec_point_initialize(1, &group_v, result);
    GetECPoint(result, point_result);

    rb_scan_args(argc, argv, "12", &arg1, &arg2, &arg3);
    if (RB_TYPE_P(arg1, T_ARRAY) || argc > 2)
        rb_raise(rb_eNotImpError, "OpenSSL::PKey::EC::Point#mul with arrays " \
                 "is no longer supported");

    BIGNUM *bn = GetBNPtr(arg1);
    if (!NIL_P(arg2))
        bn_g = GetBNPtr(arg2);
    if (EC_POINT_mul(group, point_result, bn_g, point_self, bn, ossl_bn_ctx) != 1)
        ossl_raise(eEC_POINT, NULL);

    return result;
}


  








  

    #set_to_infinity!  ⇒ self   



  

    
  



  [ GitHub ]


  

  


# File 'ext/openssl/ossl_pkey_ec.c', line 1403



static VALUE ossl_ec_point_set_to_infinity(VALUE self)
{
    EC_POINT *point;
    const EC_GROUP *group;

    GetECPoint(self, point);
    GetECPointGroup(self, group);

    if (EC_POINT_set_to_infinity(group, point) != 1)
        ossl_raise(eEC_POINT, "EC_POINT_set_to_infinity");

    return self;
}


  








  

    #to_bn([conversion_form])  ⇒ OpenSSL::BN   



  

    

Returns the octet string representation of the ::OpenSSL::PKey::EC point as an instance of ::OpenSSL::BN.



If conversion_form is not given, the point_conversion_form attribute set to the group is used.



See #to_octet_string for more information.


  



  [ GitHub ]


  

  


# File 'ext/openssl/lib/openssl/pkey.rb', line 331



def to_bn(conversion_form = group.point_conversion_form)
  OpenSSL::BN.new(to_octet_string(conversion_form), 2)
end


  








  

    #to_octet_string(conversion_form)  ⇒ String   



  

    

Returns the octet string representation of the elliptic curve point.



conversion_form specifies how the point is converted. Possible values are:


  • 

    :compressed
    

  • 

    :uncompressed
    

  • 

    :hybrid
    



  



  [ GitHub ]


  

  


# File 'ext/openssl/ossl_pkey_ec.c', line 1429



static VALUE
ossl_ec_point_to_octet_string(VALUE self, VALUE conversion_form)
{
    EC_POINT *point;
    const EC_GROUP *group;
    point_conversion_form_t form;
    VALUE str;
    size_t len;

    GetECPoint(self, point);
    GetECPointGroup(self, group);
    form = parse_point_conversion_form_symbol(conversion_form);

    len = EC_POINT_point2oct(group, point, form, NULL, 0, ossl_bn_ctx);
    if (!len)
	ossl_raise(eEC_POINT, "EC_POINT_point2oct");
    str = rb_str_new(NULL, (long)len);
    if (!EC_POINT_point2oct(group, point, form,
			    (unsigned char *)RSTRING_PTR(str), len,
			    ossl_bn_ctx))
	ossl_raise(eEC_POINT, "EC_POINT_point2oct");
    return str;
}