Class Builder

A builder for a set of attributes. Add attributes to a builder, and then use [methodBuilder.end] to get the completed [structAttributes].

The fields of #GckBuilder are private and not to be accessed directly.

record

Hierarchy

Builder

Index

Constructors

constructor

new Builder(flags: BuilderFlags): Gck.Builder

- Defined in @types/Gjs/Gck-1.d.ts:2688
Create a new GckBuilder not allocated on the stack, so it can be shared across a single scope, and referenced / unreferenced.

Normally a GckBuilder is created on the stack, and simply initialized.

If the %GCK_BUILDER_SECURE_MEMORY flag is specified then non-pageable memory will be used for the various values of the attributes in the builder

Parameters
- flags: BuilderFlags
  
  flags for the new builder
Returns Gck.Builder

Properties

Static name

name: string

Methods

add_all

add_all(attrs: Attributes): void

- Defined in @types/Gjs/Gck-1.d.ts:2373
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

- Defined in @types/Gjs/Gck-1.d.ts:2386
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 GckAttribute 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

- Defined in @types/Gjs/Gck-1.d.ts:2394
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): void

- Defined in @types/Gjs/Gck-1.d.ts:2407
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. [constINVALID] 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
- value: Uint8Array
  
  the new attribute memory
Returns void

add_date

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

- Defined in @types/Gjs/Gck-1.d.ts:2415
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

- Defined in @types/Gjs/Gck-1.d.ts:2421
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

- Defined in @types/Gjs/Gck-1.d.ts:2428
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

- Defined in @types/Gjs/Gck-1.d.ts:2445
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);
```
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

- Defined in @types/Gjs/Gck-1.d.ts:2453
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
- value: string
  
  the attribute value
Returns void

add_ulong

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

- Defined in @types/Gjs/Gck-1.d.ts:2461
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

- Defined in @types/Gjs/Gck-1.d.ts:2469
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

- Defined in @types/Gjs/Gck-1.d.ts:2477
Make a copy of the builder and its state. The new builder is allocated with [ctorBuilder.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

end

end(): Attributes

- Defined in @types/Gjs/Gck-1.d.ts:2490
Complete the #GckBuilder, and return the attributes contained in the builder. The #GckBuilder will be cleared after this function call, and it is no longer necessary to use [methodBuilder.clear] on it, although it is also permitted. The builder may be used again to build another set of attributes after this function call.

The returned set of attributes is floating, and should either be passed to another gck library function which consumes this floating reference, or if you wish to keep these attributes around you should ref them with gck_attributes_ref_sink() and unref them later with gck_attributes_unref().

Returns Attributes

find

find(attr_type: number): Gck.Attribute

- Defined in @types/Gjs/Gck-1.d.ts:2501
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 [structAttribute] 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

find_boolean

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

- Defined in @types/Gjs/Gck-1.d.ts:2509
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]

find_date

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

- Defined in @types/Gjs/Gck-1.d.ts:2517
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]

find_string

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

- Defined in @types/Gjs/Gck-1.d.ts:2525
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]

find_ulong

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

- Defined in @types/Gjs/Gck-1.d.ts:2533
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]

init

init(): void

- Defined in @types/Gjs/Gck-1.d.ts:2551
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));
```
Returns void

init_full

init_full(flags: BuilderFlags): void

- Defined in @types/Gjs/Gck-1.d.ts:2559
Initialize a stack allocated builder, with the appropriate flags.

If the %GCK_BUILDER_SECURE_MEMORY flag is specified then non-pageable memory will be used for the various values of the attributes in the builder

Parameters
- flags: BuilderFlags
  
  the flags for the new builder
Returns void

ref

ref(): Gck.Builder

- Defined in @types/Gjs/Gck-1.d.ts:2567
Add a reference to a builder that was created with [ctorBuilder.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

set_all

set_all(attrs: Attributes): void

- Defined in @types/Gjs/Gck-1.d.ts:2577
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

- Defined in @types/Gjs/Gck-1.d.ts:2585
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): void

- Defined in @types/Gjs/Gck-1.d.ts:2599
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. [constINVALID] 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
- value: Uint8Array
  
  the new attribute memory
Returns void

set_date

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

- Defined in @types/Gjs/Gck-1.d.ts:2607
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

- Defined in @types/Gjs/Gck-1.d.ts:2614
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

- Defined in @types/Gjs/Gck-1.d.ts:2621
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

- Defined in @types/Gjs/Gck-1.d.ts:2629
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

- Defined in @types/Gjs/Gck-1.d.ts:2637
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

steal

steal(): Attributes

- Defined in @types/Gjs/Gck-1.d.ts:2644
Take the attributes that have been built in the #GckBuilder. The builder will no longer contain any attributes after this function call.

The returned set of attributes is a full reference, not floating.

Returns Attributes

take_data

take_data(attr_type: number, value: Uint8Array): void

- Defined in @types/Gjs/Gck-1.d.ts:2659
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. [constINVALID] 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
- value: Uint8Array
  
  the new attribute memory
Returns void

Static new

new(flags: BuilderFlags): Gck.Builder

- Defined in @types/Gjs/Gck-1.d.ts:2700
Create a new GckBuilder not allocated on the stack, so it can be shared across a single scope, and referenced / unreferenced.

Normally a GckBuilder is created on the stack, and simply initialized.

If the %GCK_BUILDER_SECURE_MEMORY flag is specified then non-pageable memory will be used for the various values of the attributes in the builder

Parameters
- flags: BuilderFlags
  
  flags for the new builder
Returns Gck.Builder

Static unref

unref(builder: object): void

- Defined in @types/Gjs/Gck-1.d.ts:2709
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.

Parameters
- builder: object
  
  the builder
Returns void

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

flags: BuilderFlags

Returns Gck.Builder

Properties

Static name

Methods

add_all

Parameters

attrs: Attributes

Returns void

add_attribute

Parameters

attr: Gck.Attribute

Returns void

add_boolean

Parameters

attr_type: number

value: boolean

Returns void

add_data

Parameters

attr_type: number

value: Uint8Array

Returns void

add_date

Parameters

attr_type: number

value: GLib.Date

Returns void

add_empty

Parameters

attr_type: number

Returns void

add_invalid

Parameters

attr_type: number

Returns void

add_only

Parameters

attrs: Attributes

only_types: number[]

Returns void

add_string

Parameters

attr_type: number

value: string

Returns void

add_ulong

Parameters

attr_type: number

value: number

Returns void

clear

Returns void

copy

Returns Gck.Builder

end

Returns Attributes

find

Parameters

attr_type: number

Returns Gck.Attribute

find_boolean

Parameters

attr_type: number

Returns [boolean, boolean]

find_date

Parameters

attr_type: number

Returns [boolean, GLib.Date]

find_string

Parameters

attr_type: number