Gck-2 ▶ Gck ▶ Builder

constructor

• new Builder(properties?: Partial<{}>): Gck.Builder

  Parameters

  • Optionalproperties: Partial<{}>

  Returns Gck.Builder

Static$gtype

add_all

• add_all(attrs: Attributes): void

  Add all the attrs attributes to the builder. The attributes are added uncondititionally whether or not attributes with the same types already exist in the builder.

  As an optimization, the attribute memory values are automatically shared between the attributes and the builder.

  Parameters

  • attrs: Attributes

    the attributes to add

  Returns void

add_attribute

• add_attribute(attr: Gck.Attribute): void

  Add an attribute to the builder. The attribute is added unconditionally whether or not an attribute with the same type already exists on the builder.

  The attr attribute must have been created or owned by the Gck library. If you call this function on an arbitrary Gck.Attribute that is allocated on the stack or elsewhere, then this will result in undefined behavior.

  As an optimization, the attribute memory value is automatically shared between the attribute and the builder.

  Parameters

  • attr: Gck.Attribute

    the attribute to add

  Returns void

add_boolean

• add_boolean(attr_type: number, value: boolean): void

  Add a new attribute to the builder for the boolean value. Unconditionally adds a new attribute, even if one with the same attr_type already exists.

  Parameters

  • attr_type: number

    the new attribute type

  • value: boolean

    the attribute value

  Returns void

add_data

• add_data(attr_type: number, value?: Uint8Array<ArrayBufferLike>): void

  Add a new attribute to the builder with an arbitrary value. Unconditionally adds a new attribute, even if one with the same attr_type already exists.

  The memory in value is copied by the builder.

  null may be specified for the value argument, in which case an empty attribute is created. INVALID may be specified for the length, in which case an invalid attribute is created in the PKCS#11 style.

  Parameters

  • attr_type: number

    the new attribute type

  • Optionalvalue: Uint8Array<ArrayBufferLike>

    the new attribute memory

  Returns void

add_date

• add_date(attr_type: number, value: GLib.Date): void

  Add a new attribute to the builder for the date value. Unconditionally adds a new attribute, even if one with the same attr_type already exists.

  Parameters

  • attr_type: number

    the new attribute type

  • value: GLib.Date

    the attribute value

  Returns void

add_empty

• add_empty(attr_type: number): void

  Add a new attribute to the builder that is empty. Unconditionally adds a new attribute, even if one with the same attr_type already exists.

  Parameters

  • attr_type: number

    the new attribute type

  Returns void

add_invalid

• add_invalid(attr_type: number): void

  Add a new attribute to the builder that is invalid in the PKCS#11 sense. Unconditionally adds a new attribute, even if one with the same attr_type already exists.

  Parameters

  • attr_type: number

    the new attribute type

  Returns void

add_only

• add_only(attrs: Attributes, only_types: number[]): void

  Add the attributes with the types in only_types from attrs to the builder. The attributes are added uncondititionally whether or not attributes with the same types already exist in the builder.

  // Add the CKA_ID and CKA_CLASS attributes from attrs to builder
  gulong only[] = { CKA_ID, CKA_CLASS };
  gck_builder_add_onlyv (builder, attrs, only, 2);
  Copy

  As an optimization, the attribute memory values are automatically shared between the attributes and the builder.

  Parameters

  • attrs: Attributes

    the attributes to add

  • only_types: number[]

    the types of attributes to add

  Returns void

add_string

• add_string(attr_type: number, value?: string): void

  Add a new attribute to the builder for the string value or null. Unconditionally adds a new attribute, even if one with the same attr_type already exists.

  Parameters

  • attr_type: number

    the new attribute type

  • Optionalvalue: string

    the attribute value

  Returns void

add_ulong

• add_ulong(attr_type: number, value: number): void

  Add a new attribute to the builder for the unsigned long value. Unconditionally adds a new attribute, even if one with the same attr_type already exists.

  Parameters

  • attr_type: number

    the new attribute type

  • value: number

    the attribute value

  Returns void

clear

• clear(): void

  Clear the builder and release all allocated memory. The builder may be used again to build another set of attributes after this function call.

  If memory is shared between this builder and other attributes, then that memory is only freed when both of them are cleared or unreferenced.

  Returns void

copy

• copy(): Gck.Builder

  Make a copy of the builder and its state. The new builder is allocated with Builder.new and should be freed with gck_builder_unref().

  Attribute value memory is automatically shared between the two builders, and is only freed when both are gone.

  Returns Gck.Builder

  the builder copy, which should be freed with gck_builder_unref().

end

• end(): Attributes

  Take the attributes that have been built in the Gck.Builder. The builder will no longer contain any attributes after this function call.

  Returns Attributes

  the attributes, which should be freed with gck_attributes_unref()

find

• find(attr_type: number): Gck.Attribute

  Find an attribute in the builder. Both valid and invalid attributes (in the PKCS#11 sense) are returned. If multiple attributes exist for the given attribute type, then the first one is returned.

  The returned Attribute is owned by the builder and may not be modified in any way. It is only valid until another attribute is added to or set on the builder, or until the builder is cleared or unreferenced.

  Parameters

  • attr_type: number

    the type of attribute to find

  Returns Gck.Attribute

  the attribute or null if not found

find_boolean

• find_boolean(attr_type: number): [boolean, boolean]

  Find a boolean attribute in the builder that has the type attr_type, is of the correct boolean size, and is not invalid in the PKCS#11 sense. If multiple attributes exist for the given attribute type, then the first
  one is returned.

  Parameters

  • attr_type: number

    the type of attribute to find

  Returns [boolean, boolean]

  whether a valid boolean attribute was found

find_date

• find_date(attr_type: number): [boolean, GLib.Date]

  Find a date attribute in the builder that has the type attr_type, is of the correct date size, and is not invalid in the PKCS#11 sense. If multiple attributes exist for the given attribute type, then the first one is returned.

  Parameters

  • attr_type: number

    the type of attribute to find

  Returns [boolean, GLib.Date]

  whether a valid date attribute was found

find_string

• find_string(attr_type: number): [boolean, string]

  Find a string attribute in the builder that has the type attr_type, has a non null value pointer, and is not invalid in the PKCS#11 sense. If multiple attributes exist for the given attribute type, then the first one is returned.

  Parameters

  • attr_type: number

    the type of attribute to find

  Returns [boolean, string]

  whether a valid string attribute was found

find_ulong

• find_ulong(attr_type: number): [boolean, number]

  Find a unsigned long attribute in the builder that has the type attr_type, is of the correct unsigned long size, and is not invalid in the PKCS#11 sense. If multiple attributes exist for the given attribute type, then the first one is returned.

  Parameters

  • attr_type: number

    the type of attribute to find

  Returns [boolean, number]

  whether a valid unsigned long attribute was found

init

• init(): void

  Initialize a stack allocated builder, with the default flags.

  This is equivalent to initializing a builder variable with the GCK_BUILDER_INIT constant, or setting it to zeroed memory.

  // Equivalent ways of initializing a GckBuilder
  GckBuilder builder = GCK_BUILDER_INIT;
  GckBuilder builder2;
  GckBuilder builder3;
  
  gck_builder_init (&builder2);
  
  memset (&builder3, 0, sizeof (builder3));
  Copy

  Returns void

init_full

• init_full(flags: Gck.BuilderFlags): void

  Initialize a stack allocated builder, with the appropriate flags.

  If the Gck.BuilderFlags.SECURE_MEMORY flag is specified then non-pageable memory will be used for the various values of the attributes in the builder

  Parameters

  • flags: Gck.BuilderFlags

    the flags for the new builder

  Returns void

ref

• ref(): Gck.Builder

  Add a reference to a builder that was created with Builder.new. The builder must later be unreferenced again with gck_builder_unref().

  It is an error to use this function on builders that were allocated on the stack.

  Returns Gck.Builder

  the builder

set_all

• set_all(attrs: Attributes): void

  Set all the attrs attributes to the builder. If any attributes with the same types are already present in the builder, then those attributes are changed to the new values.

  As an optimization, the attribute memory values are automatically shared between the attributes and the builder.

  Parameters

  • attrs: Attributes

    the attributes to set

  Returns void

set_boolean

• set_boolean(attr_type: number, value: boolean): void

  Set an attribute on the builder for the boolean value. If an attribute with attr_type already exists in the builder then it is changed to the new value, otherwise an attribute is added.

  Parameters

  • attr_type: number

    the new attribute type

  • value: boolean

    the attribute value

  Returns void

set_data

• set_data(attr_type: number, value?: Uint8Array<ArrayBufferLike>): void

  Set a new attribute to the builder with an arbitrary value. If an attribute with attr_type already exists in the builder then it is changed to the new value, otherwise an attribute is added.

  The memory in value is copied by the builder.

  null may be specified for the value argument, in which case an empty attribute is created. INVALID may be specified for the length, in which case an invalid attribute is created in the PKCS#11 style.

  Parameters

  • attr_type: number

    the attribute type

  • Optionalvalue: Uint8Array<ArrayBufferLike>

    the new attribute memory

  Returns void

set_date

• set_date(attr_type: number, value: GLib.Date): void

  Set an attribute on the builder for the date value. If an attribute with attr_type already exists in the builder then it is changed to the new value, otherwise an attribute is added.

  Parameters

  • attr_type: number

    the new attribute type

  • value: GLib.Date

    the attribute value

  Returns void

set_empty

• set_empty(attr_type: number): void

  Set an attribute on the builder that is empty. If an attribute with attr_type already exists in the builder then it is changed to the new value, otherwise an attribute is added.

  Parameters

  • attr_type: number

    the attribute type

  Returns void

set_invalid

• set_invalid(attr_type: number): void

  Set an attribute on the builder that is invalid in the PKCS#11 sense. If an attribute with attr_type already exists in the builder then it is changed to the new value, otherwise an attribute is added.

  Parameters

  • attr_type: number

    the attribute type

  Returns void

set_string

• set_string(attr_type: number, value: string): void

  Set an attribute on the builder for the string value or null. If an attribute with attr_type already exists in the builder then it is changed to the new value, otherwise an attribute is added.

  Parameters

  • attr_type: number

    the new attribute type

  • value: string

    the attribute value

  Returns void

set_ulong

• set_ulong(attr_type: number, value: number): void

  Set an attribute on the builder for the unsigned long value. If an attribute with attr_type already exists in the builder then it is changed to the new value, otherwise an attribute is added.

  Parameters

  • attr_type: number

    the new attribute type

  • value: number

    the attribute value

  Returns void

take_data

• take_data(attr_type: number, value?: Uint8Array<ArrayBufferLike>): void

  Add a new attribute to the builder with an arbitrary value. Unconditionally adds a new attribute, even if one with the same attr_type already exists.

  Ownership of the value memory is taken by the builder, may be reallocated, and is eventually freed with g_free(). The memory must have been allocated using the standard GLib memory allocation routines.

  null may be specified for the value argument, in which case an empty attribute is created. INVALID may be specified for the length, in which case an invalid attribute is created in the PKCS#11 style.

  Parameters

  • attr_type: number

    the new attribute type

  • Optionalvalue: Uint8Array<ArrayBufferLike>

    the new attribute memory

  Returns void

unref

• unref(): void

  Unreferences a builder. If this was the last reference then the builder is freed.

  It is an error to use this function on builders that were allocated on the stack.

  Returns void

Staticnew

• new(flags: Gck.BuilderFlags): Gck.Builder

  Parameters

  • flags: Gck.BuilderFlags

  Returns Gck.Builder