Fix typos
[openssl.git] / doc / crypto / EC_KEY_new.pod
1 =pod
2
3 =head1 NAME
4
5 EC_KEY_new, EC_KEY_get_flags, EC_KEY_set_flags, EC_KEY_clear_flags, EC_KEY_new_by_curve_name, EC_KEY_free, EC_KEY_copy, EC_KEY_dup, EC_KEY_up_ref, EC_KEY_get0_group, EC_KEY_set_group, EC_KEY_get0_private_key, EC_KEY_set_private_key, EC_KEY_get0_public_key, EC_KEY_set_public_key, EC_KEY_get_enc_flags, EC_KEY_set_enc_flags, EC_KEY_get_conv_form, EC_KEY_set_conv_form, EC_KEY_get_key_method_data, EC_KEY_insert_key_method_data, EC_KEY_set_asn1_flag, EC_KEY_precompute_mult, EC_KEY_generate_key, EC_KEY_check_key, EC_KEY_set_public_key_affine_coordinates - Functions for creating, destroying and manipulating B<EC_KEY> objects.
6
7 =head1 SYNOPSIS
8
9  #include <openssl/ec.h>
10  #include <openssl/bn.h>
11
12  EC_KEY *EC_KEY_new(void);
13  int EC_KEY_get_flags(const EC_KEY *key);
14  void EC_KEY_set_flags(EC_KEY *key, int flags);
15  void EC_KEY_clear_flags(EC_KEY *key, int flags);
16  EC_KEY *EC_KEY_new_by_curve_name(int nid);
17  void EC_KEY_free(EC_KEY *key);
18  EC_KEY *EC_KEY_copy(EC_KEY *dst, const EC_KEY *src);
19  EC_KEY *EC_KEY_dup(const EC_KEY *src);
20  int EC_KEY_up_ref(EC_KEY *key);
21  const EC_GROUP *EC_KEY_get0_group(const EC_KEY *key);
22  int EC_KEY_set_group(EC_KEY *key, const EC_GROUP *group);
23  const BIGNUM *EC_KEY_get0_private_key(const EC_KEY *key);
24  int EC_KEY_set_private_key(EC_KEY *key, const BIGNUM *prv);
25  const EC_POINT *EC_KEY_get0_public_key(const EC_KEY *key);
26  int EC_KEY_set_public_key(EC_KEY *key, const EC_POINT *pub);
27  point_conversion_form_t EC_KEY_get_conv_form(const EC_KEY *key);
28  void EC_KEY_set_conv_form(EC_KEY *eckey, point_conversion_form_t cform);
29  void *EC_KEY_get_key_method_data(EC_KEY *key, 
30         void *(*dup_func)(void *), void (*free_func)(void *), void (*clear_free_func)(void *));
31  void EC_KEY_insert_key_method_data(EC_KEY *key, void *data,
32         void *(*dup_func)(void *), void (*free_func)(void *), void (*clear_free_func)(void *));
33  void EC_KEY_set_asn1_flag(EC_KEY *eckey, int asn1_flag);
34  int EC_KEY_precompute_mult(EC_KEY *key, BN_CTX *ctx);
35  int EC_KEY_generate_key(EC_KEY *key);
36  int EC_KEY_check_key(const EC_KEY *key);
37  int EC_KEY_set_public_key_affine_coordinates(EC_KEY *key, BIGNUM *x, BIGNUM *y);
38
39 =head1 DESCRIPTION
40
41 An EC_KEY represents a public key and (optionally) an associated private key. A new EC_KEY (with no associated curve) can be constructed by calling EC_KEY_new.
42 The reference count for the newly created EC_KEY is initially set to 1. A curve can be associated with the EC_KEY by calling
43 EC_KEY_set_group.
44
45 Alternatively a new EC_KEY can be constructed by calling EC_KEY_new_by_curve_name and supplying the nid of the associated curve. Refer to L<EC_GROUP_new(3)> for a description of curve names. This function simply wraps calls to EC_KEY_new and 
46 EC_GROUP_new_by_curve_name.
47
48 Calling EC_KEY_free decrements the reference count for the EC_KEY object, and if it has dropped to zero then frees the memory associated
49 with it.
50 If B<key> is NULL nothing is done.
51
52 EC_KEY_copy copies the contents of the EC_KEY in B<src> into B<dest>.
53
54 EC_KEY_dup creates a new EC_KEY object and copies B<ec_key> into it.
55
56 EC_KEY_up_ref increments the reference count associated with the EC_KEY object.
57
58 EC_KEY_generate_key generates a new public and private key for the supplied B<eckey> object. B<eckey> must have an EC_GROUP object
59 associated with it before calling this function. The private key is a random integer (0 < priv_key < order, where order is the order
60 of the EC_GROUP object). The public key is an EC_POINT on the curve calculated by multiplying the generator for the curve by the
61 private key.
62
63 EC_KEY_check_key performs various sanity checks on the EC_KEY object to confirm that it is valid.
64
65 EC_KEY_set_public_key_affine_coordinates sets the public key for B<key> based on its affine co-ordinates, i.e. it constructs an EC_POINT
66 object based on the supplied B<x> and B<y> values and sets the public key to be this EC_POINT. It will also performs certain sanity checks
67 on the key to confirm that it is valid.
68
69 The functions EC_KEY_get0_group, EC_KEY_set_group, EC_KEY_get0_private_key, EC_KEY_set_private_key, EC_KEY_get0_public_key, and EC_KEY_set_public_key get and set the EC_GROUP object, the private key and the EC_POINT public key for the B<key> respectively.
70
71 The functions EC_KEY_get_conv_form and EC_KEY_set_conv_form get and set the point_conversion_form for the B<key>. For a description
72 of point_conversion_forms please refer to L<EC_POINT_new(3)>.
73
74 EC_KEY_insert_key_method_data and EC_KEY_get_key_method_data enable the caller to associate arbitrary additional data specific to the
75 elliptic curve scheme being used with the EC_KEY object. This data is treated as a "black box" by the ec library. The data to be stored by EC_KEY_insert_key_method_data is provided in the B<data> parameter, which must have associated functions for duplicating, freeing and "clear_freeing" the data item. If a subsequent EC_KEY_get_key_method_data call is issued, the functions for duplicating, freeing and "clear_freeing" the data item must be provided again, and they must be the same as they were when the data item was inserted.
76
77 EC_KEY_set_flags sets the flags in the B<flags> parameter on the EC_KEY object. Any flags that are already set are left set. The currently defined standard flags are EC_FLAG_NON_FIPS_ALLOW and EC_FLAG_FIPS_CHECKED. In addition there is the flag EC_FLAG_COFACTOR_ECDH which is specific to ECDH and is defined in ecdh.h. EC_KEY_get_flags returns the current flags that are set for this EC_KEY. EC_KEY_clear_flags clears the flags indicated by the B<flags> parameter. All other flags are left in their existing state.
78
79 EC_KEY_set_asn1_flag sets the asn1_flag on the underlying EC_GROUP object (if set). Refer to L<EC_GROUP_copy(3)> for further information on the asn1_flag.
80
81 EC_KEY_precompute_mult stores multiples of the underlying EC_GROUP generator for faster point multiplication. See also L<EC_POINT_add(3)>.
82
83
84 =head1 RETURN VALUES
85
86 EC_KEY_new, EC_KEY_new_by_curve_name and EC_KEY_dup return a pointer to the newly created EC_KEY object, or NULL on error.
87
88 EC_KEY_get_flags returns the flags associated with the EC_KEY object as an integer.
89
90 EC_KEY_copy returns a pointer to the destination key, or NULL on error.
91
92 EC_KEY_up_ref, EC_KEY_set_group, EC_KEY_set_private_key, EC_KEY_set_public_key, EC_KEY_precompute_mult, EC_KEY_generate_key, EC_KEY_check_key and EC_KEY_set_public_key_affine_coordinates return 1 on success or 0 on error.
93
94 EC_KEY_get0_group returns the EC_GROUP associated with the EC_KEY.
95
96 EC_KEY_get0_private_key returns the private key associated with the EC_KEY.
97
98 EC_KEY_get_conv_form return the point_conversion_form for the EC_KEY.
99
100
101 =head1 SEE ALSO
102
103 L<crypto(3)>, L<ec(3)>, L<EC_GROUP_new(3)>,
104 L<EC_GROUP_copy(3)>, L<EC_POINT_new(3)>,
105 L<EC_POINT_add(3)>,
106 L<EC_GFp_simple_method(3)>,
107 L<d2i_ECPKParameters(3)>
108
109 =cut