Class (GI Class)

Gcr-4GcrPkcs11Certificate

A certificate loaded from a PKCS#11 storage. It is also a valid Gck.Object and can be used as such.

Use Gcr.Pkcs11Certificate.lookup_issuer to lookup the issuer of a given certificate in the PKCS#11 store.

Various common PKCS#11 certificate attributes are automatically loaded and are available via Gcr.Pkcs11Certificate.get_attributes.

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Accessors - Inherited from Gcr.Certificate

Accessors - Inherited from Gck

Methods

Methods - Inherited from Gck

Constructors

Properties

Compile-time signal type information.

This instance property is generated only for TypeScript type checking. It is not defined at runtime and should not be accessed in JS code.

Accessors

Accessors - Inherited from Gcr.Certificate

  • get description(): string

    A readable description for this certificate

    Returns string

  • get issuer_name(): string

    Common name part of the certificate issuer

    Returns string

  • get issuerName(): string

    Common name part of the certificate issuer

    Returns string

  • get label(): string

    A readable label for this certificate.

    Returns string

  • get subject_name(): string

    Returns string

  • get subjectName(): string

    Returns string

Accessors - Inherited from Gck

  • get handle(): number

    The raw PKCS11 handle for this object.

    Returns number

  • get session(): Gck.Session

    The PKCS11 session to make calls on when this object needs to perform operations on itself.

    If this is NULL then a new session is opened for each operation, such as gck_object_get(), gck_object_set() or gck_object_destroy().

    Returns Gck.Session

Methods

  • Creates a binding between source_property on source and target_property on target.

    Whenever the source_property is changed the target_property is updated using the same value. For instance:

      g_object_bind_property (action, "active", widget, "sensitive", 0);
    

    Will result in the "sensitive" property of the widget GObject.Object instance to be updated with the same value of the "active" property of the action GObject.Object instance.

    If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual: if target_property on target changes then the source_property on source will be updated as well.

    The binding will automatically be removed when either the source or the target instances are finalized. To remove the binding without affecting the source and the target you can just call g_object_unref() on the returned GObject.Binding instance.

    Removing the binding by calling g_object_unref() on it must only be done if the binding, source and target are only used from a single thread and it is clear that both source and target outlive the binding. Especially it is not safe to rely on this if the binding, source or target can be finalized from different threads. Keep another reference to the binding and use g_binding_unbind() instead to be on the safe side.

    A GObject.Object can have multiple bindings.

    Parameters

    Returns GObject.Binding

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

  • Complete version of g_object_bind_property().

    Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

    If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual: if target_property on target changes then the source_property on source will be updated as well. The transform_from function is only used in case of bidirectional bindings, otherwise it will be ignored

    The binding will automatically be removed when either the source or the target instances are finalized. This will release the reference that is being held on the GObject.Binding instance; if you want to hold on to the GObject.Binding instance, you will need to hold a reference to it.

    To remove the binding, call g_binding_unbind().

    A GObject.Object can have multiple bindings.

    The same user_data parameter will be used for both transform_to and transform_from transformation functions; the notify function will be called once, when the binding is removed. If you need different data for each transformation function, please use g_object_bind_property_with_closures() instead.

    Parameters

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target GObject.Object

    • target_property: string

      the property on target to bind

    • flags: GObject.BindingFlags

      flags to pass to GObject.Binding

    • Optionaltransform_to: BindingTransformFunc

      the transformation function from the source to the target, or null to use the default

    • Optionaltransform_from: BindingTransformFunc

      the transformation function from the target to the source, or null to use the default

    • Optionalnotify: DestroyNotify

      a function to call when disposing the binding, to free resources used by the transformation functions, or null if not required

    Returns GObject.Binding

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

  • Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

    This function is the language bindings friendly version of g_object_bind_property_full(), using GClosures instead of function pointers.

    Parameters

    • ...args: never[]

      the property on source to bind

    Returns any

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

  • Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.

    Parameters

    • id: number

      Handler ID of the handler to be disconnected

    Returns void

  • This function is intended for GObject.Object implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().

    Returns void

  • Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one GObject.Object::notify signal is emitted for each property modified while the object is frozen.

    This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.

    Returns void

  • Get the basic constraints for the certificate if present. If false is returned then no basic constraints are present and the is_ca and path_len arguments are not changed.

    Returns [boolean, boolean, number]

    whether basic constraints are present or not

  • Gets a named field from the objects table of associations (see g_object_set_data()).

    Parameters

    • key: string

      name of the key for that association

    Returns any

    the data if found, or null if no such data exists.

  • Parameters

    • ...args: never[]

    Returns any

  • Calculate the fingerprint for this certificate.

    The caller should free the returned data using g_free() when it is no longer required.

    Parameters

    • type: ChecksumType

      the type of algorithm for the fingerprint.

    Returns Uint8Array<ArrayBufferLike>

    the raw binary fingerprint

  • Calculate the fingerprint for this certificate, and return it as a hex string.

    The caller should free the returned data using g_free() when it is no longer required.

    Parameters

    • type: ChecksumType

      the type of algorithm for the fingerprint.

    Returns string

    an allocated hex string which contains the fingerprint.

  • Get the common name of the issuer of this certificate.

    The string returned should be freed by the caller when no longer required.

    Returns string

    The allocated issuer CN, or null if no issuer CN present.

  • Get the full issuer DN of the certificate as a (mostly) readable string.

    The string returned should be freed by the caller when no longer required.

    Returns string

    The allocated issuer DN of the certificate.

  • Get a name to represent the issuer of this certificate.

    This will try to lookup the common name, orianizational unit, organization in that order.

    Returns string

    the allocated issuer name, or null if no issuer name

  • Get a part of the DN of the issuer of this certificate.

    Examples of a part might be the 'OU' (organizational unit) or the 'CN' (common name). Only the value of that part of the DN is returned.

    The string returned should be freed by the caller when no longer required.

    Parameters

    • part: string

      a DN type string or OID.

    Returns string

    the allocated part of the issuer DN, or null if no such part is present

  • Get the raw DER data for the issuer DN of the certificate.

    The data should be freed by using g_free() when no longer required.

    Returns Uint8Array<ArrayBufferLike>

    allocated memory containing the raw issuer

  • Gets a property of an object.

    The value can be:

    • an empty GObject.Value initialized by G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a GObject.Value initialized with the expected type of the property
    • a GObject.Value initialized with a type to which the expected type of the property can be transformed

    In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.

    Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.

    Parameters

    • property_name: string

      The name of the property to get

    • value: any

      Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type

    Returns any

  • Get the raw binary serial number of the certificate.

    The caller should free the returned data using g_free() when it is no longer required.

    Returns Uint8Array<ArrayBufferLike>

    the raw binary serial number.

  • Get the serial number of the certificate as a hex string.

    The caller should free the returned data using g_free() when it is no longer required.

    Returns string

    an allocated string containing the serial number as hex.

  • Get the common name of the subject of this certificate.

    The string returned should be freed by the caller when no longer required.

    Returns string

    The allocated subject CN, or null if no subject CN present.

  • Get the full subject DN of the certificate as a (mostly) readable string.

    The string returned should be freed by the caller when no longer required.

    Returns string

    The allocated subject DN of the certificate.

  • Get a name to represent the subject of this certificate.

    This will try to lookup the common name, orianizational unit, organization in that order.

    Returns string

    the allocated subject name, or null if no subject name

  • Get a part of the DN of the subject of this certificate.

    Examples of a part might be the 'OU' (organizational unit) or the 'CN' (common name). Only the value of that part of the DN is returned.

    The string returned should be freed by the caller when no longer required.

    Parameters

    • part: string

      a DN type string or OID.

    Returns string

    the allocated part of the subject DN, or null if no such part is present.

  • Get the raw DER data for the subject DN of the certificate.

    The data should be freed by using g_free() when no longer required.

    Returns Uint8Array<ArrayBufferLike>

    allocated memory containing the raw subject

  • Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

    Parameters

    • names: string[]

      the names of each property to get

    • values: any[]

      the values of each property to get

    Returns void

  • Check if issuer could be the issuer of this certificate. This is done by comparing the relevant subject and issuer fields. No signature check is done. Proper verification of certificates must be done via a crypto library.

    Parameters

    Returns boolean

    whether issuer could be the issuer of the certificate.

  • Emits a "notify" signal for the property property_name on object.

    When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

    Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

    Parameters

    • property_name: string

      the name of a property installed on the class of object.

    Returns void

  • Emits a "notify" signal for the property specified by pspec on object.

    This function omits the property name lookup, hence it is faster than g_object_notify().

    One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:

      typedef enum
    {
    PROP_FOO = 1,
    PROP_LAST
    } MyObjectProperty;

    static GParamSpec *properties[PROP_LAST];

    static void
    my_object_class_init (MyObjectClass *klass)
    {
    properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
    0, 100,
    50,
    G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
    g_object_class_install_property (gobject_class,
    PROP_FOO,
    properties[PROP_FOO]);
    }

    and then notify a change on the "foo" property with:

      g_object_notify_by_pspec (self, properties[PROP_FOO]);
    

    Parameters

    Returns void

  • Increases the reference count of object.

    Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type of object will be propagated to the return type (using the GCC typeof() extension), so any casting the caller needs to do on the return type must be explicit.

    Returns GObject.Object

    the same object

  • Increase the reference count of object, and possibly remove the [floating][floating-ref] reference, if object has a floating reference.

    In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.

    Since GLib 2.56, the type of object will be propagated to the return type under the same conditions as for g_object_ref().

    Returns GObject.Object

    object

  • Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.

    Parameters

    • properties: { [key: string]: any }

      Object containing the properties to set

    Returns void

  • Parameters

    • ...args: never[]

    Returns any

  • Each object carries around a table of associations from strings to pointers. This function lets you set an association.

    If the object already had an association with that name, the old association will be destroyed.

    Internally, the key is converted to a GLib.Quark using g_quark_from_string(). This means a copy of key is kept permanently (even after object has been finalized) — so it is recommended to only use a small, bounded set of values for key in your program, to avoid the GLib.Quark storage growing unbounded.

    Parameters

    • key: string

      name of the key

    • Optionaldata: any

      data to associate with that key

    Returns void

  • Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

    Parameters

    • key: string

      name of the key

    Returns any

    the data if found, or null if no such data exists.

  • This function gets back user data pointers stored via g_object_set_qdata() and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:

    void
    object_add_to_user_list (GObject *object,
    const gchar *new_string)
    {
    // the quark, naming the object data
    GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
    // retrieve the old string list
    GList *list = g_object_steal_qdata (object, quark_string_list);

    // prepend new string
    list = g_list_prepend (list, g_strdup (new_string));
    // this changed 'list', so we need to set it again
    g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
    }
    static void
    free_string_list (gpointer data)
    {
    GList *node, *list = data;

    for (node = list; node; node = node->next)
    g_free (node->data);
    g_list_free (list);
    }

    Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().

    Parameters

    • quark: number

      A GLib.Quark, naming the user data pointer

    Returns any

    The user data pointer set, or null

  • Reverts the effect of a previous call to g_object_freeze_notify(). The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.

    Duplicate notifications for each property are squashed so that at most one GObject.Object::notify signal is emitted for each property, in the reverse order in which they have been queued.

    It is an error to call this function when the freeze count is zero.

    Returns void

  • Decreases the reference count of object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).

    If the pointer to the GObject.Object may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to null rather than retain a dangling pointer to a potentially invalid GObject.Object instance. Use g_clear_object() for this.

    Returns void

  • the constructed function is called by g_object_new() as the final step of the object creation process. At the point of the call, all construction properties have been set on the object. The purpose of this call is to allow for object initialisation steps that can only be performed after construction properties have been set. constructed implementors should chain up to the constructed call of their parent class to allow it to complete its initialisation.

    Returns void

  • the dispose function is supposed to drop all references to other objects, but keep the instance otherwise intact, so that client method invocations still work. It may be run multiple times (due to reference loops). Before returning, dispose should chain up to the dispose method of the parent class.

    Returns void

  • Emits a "notify" signal for the property property_name on object.

    When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

    Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

    Parameters

    Returns void

  • the generic setter for all properties of this type. Should be overridden for every type with properties. If implementations of set_property don't emit property change notification explicitly, this will be done implicitly by the type system. However, if the notify signal is emitted explicitly, the type system will not emit it a second time.

    Parameters

    Returns void

  • This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling g_closure_invalidate() on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, g_object_ref() and g_object_unref() are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.

    Parameters

    Returns void

  • Lookup a certificate in the PKCS#11 storage by the given URI.

    This call may block, see gcr_pkcs11_certificate_new_from_uri_async() for the non-blocking version.

    Will return null if no certificate is found. Use error to determine if an error occurred.

    Parameters

    Returns Gcr.Certificate

Methods - Inherited from Gck

  • Lookup attributes in the cache, or retrieve them from the object if necessary.

    If object is a Gck.ObjectCache then this will lookup the attributes there first if available, otherwise will read them from the object and update the cache.

    If object is not a Gck.ObjectCache, then the attributes will simply be read from the object.

    This may block, use the asynchronous version when this is not desirable

    Parameters

    • attr_types: number[]

      the types of attributes to update

    • Optionalcancellable: Gio.Cancellable

      optional cancellation object

    Returns Attributes

    the attributes retrieved or null on failure

  • Destroy a PKCS#11 object, deleting it from storage or the session. This call may block for an indefinite period.

    Parameters

    • Optionalcancellable: Gio.Cancellable

      Optional cancellable object, or null to ignore.

    Returns boolean

    Whether the call was successful or not.

  • Get the status of the operation to destroy a PKCS#11 object, begun with gck_object_destroy_async().

    Parameters

    • result: Gio.AsyncResult

      The result of the destory operation passed to the callback.

    Returns boolean

    Whether the object was destroyed successfully or not.

  • Checks equality of two objects. Two GckObject objects can point to the same underlying PKCS#11 object.

    Parameters

    Returns boolean

    true if object1 and object2 are equal. false if either is not a GckObject.

  • Get the specified attributes from the object. The attributes will be cleared of their current values, and new attributes will be stored. The attributes should not be accessed in any way except for referencing and unreferencing them until gck_object_get_finish() is called.

    This call returns immediately and completes asynchronously.

    Parameters

    • attr_types: number[]

      the types of the attributes to get

    • Optionalcancellable: Gio.Cancellable

      optional cancellation object, or null

    Returns Promise<Attributes>

  • Get the specified attributes from the object. The attributes will be cleared of their current values, and new attributes will be stored. The attributes should not be accessed in any way except for referencing and unreferencing them until gck_object_get_finish() is called.

    This call returns immediately and completes asynchronously.

    Parameters

    Returns void

  • Get the specified attributes from the object. The attributes will be cleared of their current values, and new attributes will be stored. The attributes should not be accessed in any way except for referencing and unreferencing them until gck_object_get_finish() is called.

    This call returns immediately and completes asynchronously.

    Parameters

    Returns void | Promise<Attributes>

  • Get the result of an operation to get attribute data from an object. For convenience the returned data has an extra null terminator, not included in the returned length.

    Parameters

    Returns Uint8Array

    The PKCS#11 attribute data or null if an error occurred.

  • Get the specified attributes from the object. This call may block for an indefinite period.

    No extra references are added to the returned attributes pointer. During this call you may not access the attributes in any way.

    Parameters

    • attr_types: number[]

      the types of the attributes to get

    • Optionalcancellable: Gio.Cancellable

      optional cancellation object, or null

    Returns Attributes

    a pointer to the filled in attributes if successful, or null if not

  • Get the PKCS#11 session assigned to make calls on when operating on this object.

    This will only return a session if it was set explitly on this object. By default an object will open and close sessions appropriate for its calls.

    Returns Gck.Session

    the assigned session, which must be unreffed after use

  • Get an attribute template from the object. The attr_type must be for an attribute which returns a template.

    This call may block for an indefinite period.

    Parameters

    • attr_type: number

      The template attribute type.

    • Optionalcancellable: Gio.Cancellable

      Optional cancellation object, or null.

    Returns Attributes

    the resulting PKCS#11 attribute template, or null if an error occurred

  • Create a hash value for the GckObject.

    This function is intended for easily hashing a GckObject to add to a GHashTable or similar data structure.

    Returns number

    An integer that can be used as a hash value, or 0 if invalid.

  • Get the status of the operation to set attributes on a PKCS#11 object, begun with gck_object_set_async().

    Parameters

    • result: Gio.AsyncResult

      The result of the destory operation passed to the callback.

    Returns boolean

    Whether the attributes were successfully set on the object or not.

  • Set an attribute template on the object. The attr_type must be for an attribute which contains a template.

    If the attrs Gck.Attributes is floating, it is consumed.

    This call may block for an indefinite period.

    Parameters

    • attr_type: number

      The attribute template type.

    • attrs: Attributes

      The attribute template.

    • Optionalcancellable: Gio.Cancellable

      Optional cancellation object, or null.

    Returns boolean

    true if the operation succeeded.

  • Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created GObject.ParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.

    This function is meant to be called from the interface's default vtable initialization function (the class_init member of GObject.TypeInfo.) It must not be called after after class_init has been called for any object types implementing this interface.

    If pspec is a floating reference, it will be consumed.

    Parameters

    Returns void

  • Parameters

    • property_id: number

      the new property ID

    • name: string

      the name of a property registered in a parent class or in an interface of this class.

    Returns void

Interfaces

ConstructorProps
SignalSignatures