Gjsify LogoGjsify Logo

Represents an open PKCS11 session.

Before performing any PKCS11 operations, a session must be opened. This is analogous to an open database handle, or a file handle.

Hierarchy

Index

Constructors

Properties

appData: object

Raw PKCS#11 application data used to open the PKCS#11 session.

gTypeInstance: TypeInstance
handle: number

The raw CK_SESSION_HANDLE handle of this session.

interaction: TlsInteraction

Interaction object used to ask the user for pins when opening sessions. Used if the session_options of the enumerator have %GCK_SESSION_LOGIN_USER

module: Gck.Module

The GckModule that this session is opened on.

openingFlags: number

Raw PKCS#11 flags used to open the PKCS#11 session.

The options this session was opened with.

parent: GObject.Object
slot: Gck.Slot

The GckSlot this session is opened on.

$gtype: GType<Gck.Session>
name: string

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 instance to be updated with the same value of the "active" property of the action #GObject instance.

    If flags contains %G_BINDING_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 #GBinding 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 can have multiple bindings.

    Parameters

    • sourceProperty: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • targetProperty: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    Returns Binding

  • 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

    • sourceProperty: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • targetProperty: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    • transformTo: TClosure<any, any>

      a #GClosure wrapping the transformation function from the source to the target, or %NULL to use the default

    • transformFrom: TClosure<any, any>

      a #GClosure wrapping the transformation function from the target to the source, or %NULL to use the default

    Returns Binding

  • connect(sigName: "discard-handle", callback: Session_DiscardHandleSignalCallback): number
  • connect(sigName: "notify::app-data", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::handle", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::interaction", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::module", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::opening-flags", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::options", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::slot", callback: ((...args: any[]) => void)): number
  • connect(sigName: string, callback: ((...args: any[]) => void)): number
  • Parameters

    Returns number

  • Parameters

    • sigName: "notify::app-data"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::handle"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::interaction"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::module"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::opening-flags"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::options"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: "notify::slot"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns number

  • Create a new PKCS#11 object. This call may block for an indefinite period.

    If the attrs #GckAttributes is floating, it is consumed.

    Parameters

    • attrs: Attributes

      The attributes to create the object with.

    • cancellable: Gio.Cancellable

      Optional cancellation object, or %NULL.

    Returns Gck.Object

  • Create a new PKCS#11 object. This call will return immediately and complete asynchronously.

    If attrs is a floating reference, it is consumed.

    Parameters

    Returns void

  • Decrypt data in a mechanism specific manner. This call may block for an indefinite period.

    Parameters

    • key: Gck.Object

      The key to decrypt with.

    • mechType: number

      The mechanism type to use for decryption.

    • input: Uint8Array

      data to decrypt

    • cancellable: Gio.Cancellable

      Optional cancellation object, or %NULL

    Returns Uint8Array

  • Decrypt data in a mechanism specific manner. This call will return immediately and complete asynchronously.

    Parameters

    • key: Gck.Object

      The key to decrypt with.

    • mechanism: Mechanism

      The mechanism type and parameters to use for decryption.

    • input: Uint8Array

      data to decrypt

    • cancellable: Gio.Cancellable

      A GCancellable which can be used to cancel the operation.

    • callback: AsyncReadyCallback

      Called when the operation completes.

    Returns void

  • Get the result of an decryption operation.

    Parameters

    • result: AsyncResult

      The result object passed to the callback.

    Returns Uint8Array

  • Decrypt data in a mechanism specific manner. This call may block for an indefinite period.

    Parameters

    • key: Gck.Object

      The key to decrypt with.

    • mechanism: Mechanism

      The mechanism type and parameters to use for decryption.

    • input: Uint8Array

      data to decrypt

    • cancellable: Gio.Cancellable

      A GCancellable which can be used to cancel the operation.

    Returns Uint8Array

  • Derive a key from another key. This call may block for an indefinite period.

    If the attrs #GckAttributes is floating, it is consumed.

    Parameters

    • base: Gck.Object

      The key to derive from.

    • mechType: number

      The mechanism to use for derivation.

    • attrs: Attributes

      Additional attributes for the derived key.

    • cancellable: Gio.Cancellable

      Optional cancellation object, or %NULL.

    Returns Gck.Object

  • Derive a key from another key. This call will return immediately and complete asynchronously.

    If the attrs #GckAttributes is floating, it is consumed.

    Parameters

    Returns void

  • Derive a key from another key. This call may block for an indefinite period.

    If the attrs #GckAttributes is floating, it is consumed.

    Parameters

    • base: Gck.Object

      The key to derive from.

    • mechanism: Mechanism

      The mechanism to use for derivation.

    • attrs: Attributes

      Additional attributes for the derived key.

    • cancellable: Gio.Cancellable

      Optional cancellation object, or %NULL.

    Returns Gck.Object

  • emit(sigName: "discard-handle", ...args: any[]): void
  • emit(sigName: "notify::app-data", ...args: any[]): void
  • emit(sigName: "notify::handle", ...args: any[]): void
  • emit(sigName: "notify::interaction", ...args: any[]): void
  • emit(sigName: "notify::module", ...args: any[]): void
  • emit(sigName: "notify::opening-flags", ...args: any[]): void
  • emit(sigName: "notify::options", ...args: any[]): void
  • emit(sigName: "notify::slot", ...args: any[]): void
  • emit(sigName: string, ...args: any[]): void
  • Parameters

    • sigName: "discard-handle"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::app-data"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::handle"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::interaction"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::module"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::opening-flags"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::options"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::slot"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: string
    • Rest ...args: any[]

    Returns void

  • Encrypt data in a mechanism specific manner. This call may block for an indefinite period.

    Parameters

    • key: Gck.Object

      The key to encrypt with.

    • mechType: number

      The mechanism type to use for encryption.

    • input: Uint8Array

      the data to encrypt

    • cancellable: Gio.Cancellable

      Optional cancellation object, or %NULL

    Returns Uint8Array

  • Encrypt data in a mechanism specific manner. This call will return immediately and complete asynchronously.

    Parameters

    • key: Gck.Object

      The key to encrypt with.

    • mechanism: Mechanism

      The mechanism type and parameters to use for encryption.

    • input: Uint8Array

      the data to encrypt

    • cancellable: Gio.Cancellable

      A GCancellable which can be used to cancel the operation.

    • callback: AsyncReadyCallback

      Called when the operation completes.

    Returns void

  • Get the result of an encryption operation.

    Parameters

    • result: AsyncResult

      The result object passed to the callback.

    Returns Uint8Array

  • Encrypt data in a mechanism specific manner. This call may block for an indefinite period.

    Parameters

    • key: Gck.Object

      The key to encrypt with.

    • mechanism: Mechanism

      The mechanism type and parameters to use for encryption.

    • input: Uint8Array

      the data to encrypt

    • cancellable: Gio.Cancellable

      A GCancellable which can be used to cancel the operation.

    Returns Uint8Array

  • Setup an enumerator for listing matching objects available via this session.

    If match is a floating reference, it is consumed.

    This call will not block but will return an enumerator immediately.

    Parameters

    • match: Attributes

      attributes that the objects must match, or empty for all objects

    Returns Gck.Enumerator

  • Find the objects matching the passed attributes. This call may block for an indefinite period.

    If match is a floating reference, it is consumed.

    Parameters

    • match: Attributes

      the attributes to match against objects

    • cancellable: Gio.Cancellable

      optional cancellation object or %NULL

    Returns number[]

  • Find the objects matching the passed attributes. This call will return immediately and complete asynchronously.

    If match is a floating reference, it is consumed.

    Parameters

    Returns void

  • Get the result of a find handles operation.

    Parameters

    Returns number[]

  • Find the objects matching the passed attributes. This call may block for an indefinite period.

    If match is a floating reference, it is consumed.

    Parameters

    Returns Gck.Object[]

  • Find the objects matching the passed attributes. This call will return immediately and complete asynchronously.

    If the match #GckAttributes is floating, it is consumed.

    Parameters

    Returns void

  • forceFloating(): void
  • This function is intended for #GObject 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

  • freezeNotify(): 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::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

  • Generate a new key pair of public and private keys. This call may block for an indefinite period.

    If public_attrs and/or private_attrs is a floating reference, it is consumed.

    Parameters

    • mechType: number

      The mechanism type to use for key generation.

    • publicAttrs: Attributes

      Additional attributes for the generated public key.

    • privateAttrs: Attributes

      Additional attributes for the generated private key.

    • cancellable: Gio.Cancellable

      Optional cancellation object, or %NULL.

    Returns [boolean, Gck.Object, Gck.Object]

  • Generate a new key pair of public and private keys. This call will return immediately and complete asynchronously.

    If public_attrs and/or private_attrs is a floating reference, it is consumed.

    Parameters

    • mechanism: Mechanism

      The mechanism to use for key generation.

    • publicAttrs: Attributes

      Additional attributes for the generated public key.

    • privateAttrs: Attributes

      Additional attributes for the generated private key.

    • cancellable: Gio.Cancellable

      Optional cancellation object or %NULL.

    • callback: AsyncReadyCallback

      Called when the operation completes.

    Returns void

  • Generate a new key pair of public and private keys. This call may block for an indefinite period.

    If public_attrs and/or private_attrs is a floating reference, it is consumed.

    Parameters

    • mechanism: Mechanism

      The mechanism to use for key generation.

    • publicAttrs: Attributes

      Additional attributes for the generated public key.

    • privateAttrs: Attributes

      Additional attributes for the generated private key.

    • cancellable: Gio.Cancellable

      Optional cancellation object, or %NULL.

    Returns [boolean, Gck.Object, Gck.Object]

  • getData(key?: string): object
  • Gets a named field from the objects table of associations (see g_object_set_data()).

    Parameters

    • Optional key: string

      name of the key for that association

    Returns object

  • getHandle(): number
  • Get the raw PKCS#11 session handle from a session object.

    Returns number

  • getProperty(propertyName?: string, value?: any): void
  • Gets a property of an object.

    The value can be:

    • an empty #GValue initialized by %G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a #GValue initialized with the expected type of the property
    • a #GValue 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 g_value_unset().

    Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.

    Parameters

    • Optional propertyName: string

      the name of the property to get

    • Optional value: any

      return location for the property value

    Returns void

  • getQdata(quark: number): object
  • This function gets back user data pointers stored via g_object_set_qdata().

    Parameters

    • quark: number

      A #GQuark, naming the user data pointer

    Returns object

  • getState(): number
  • Get the session state. The state is the various PKCS#11 CKS_XXX flags.

    Returns number

  • getv(names: string[], values: any[]): void
  • 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

  • Initializes the object implementing the interface.

    This method is intended for language bindings. If writing in C, g_initable_new() should typically be used instead.

    The object must be initialized before any real use after initial construction, either with this function or g_async_initable_init_async().

    Implementations may also support cancellation. If cancellable is not %NULL, then initialization can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If cancellable is not %NULL and the object doesn't support cancellable initialization the error %G_IO_ERROR_NOT_SUPPORTED will be returned.

    If the object is not initialized, or initialization returns with an error, then all operations on the object except g_object_ref() and g_object_unref() are considered to be invalid, and have undefined behaviour. See the [introduction][ginitable] for more details.

    Callers should not assume that a class which implements #GInitable can be initialized multiple times, unless the class explicitly documents itself as supporting this. Generally, a class’ implementation of init() can assume (and assert) that it will only be called once. Previously, this documentation recommended all #GInitable implementations should be idempotent; that recommendation was relaxed in GLib 2.54.

    If a class explicitly supports being initialized multiple times, it is recommended that the method is idempotent: multiple calls with the same arguments should return the same results. Only the first call initializes the object; further calls return the result of the first call.

    One reason why a class might need to support idempotent initialization is if it is designed to be used via the singleton pattern, with a #GObjectClass.constructor that sometimes returns an existing instance. In this pattern, a caller would expect to be able to call g_initable_init() on the result of g_object_new(), regardless of whether it is in fact a new instance.

    Parameters

    • Optional cancellable: Gio.Cancellable

      optional #GCancellable object, %NULL to ignore.

    Returns boolean

  • Starts asynchronous initialization of the object implementing the interface. This must be done before any real use of the object after initial construction. If the object also implements #GInitable you can optionally call g_initable_init() instead.

    This method is intended for language bindings. If writing in C, g_async_initable_new_async() should typically be used instead.

    When the initialization is finished, callback will be called. You can then call g_async_initable_init_finish() to get the result of the initialization.

    Implementations may also support cancellation. If cancellable is not %NULL, then initialization can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If cancellable is not %NULL, and the object doesn't support cancellable initialization, the error %G_IO_ERROR_NOT_SUPPORTED will be returned.

    As with #GInitable, if the object is not initialized, or initialization returns with an error, then all operations on the object except g_object_ref() and g_object_unref() are considered to be invalid, and have undefined behaviour. They will often fail with g_critical() or g_warning(), but this must not be relied on.

    Callers should not assume that a class which implements #GAsyncInitable can be initialized multiple times; for more information, see g_initable_init(). If a class explicitly supports being initialized multiple times, implementation requires yielding all subsequent calls to init_async() on the results of the first call.

    For classes that also support the #GInitable interface, the default implementation of this method will run the g_initable_init() function in a thread, so if you want to support asynchronous initialization via threads, just implement the #GAsyncInitable interface without overriding any interface methods.

    Parameters

    • ioPriority: number

      the [I/O priority][io-priority] of the operation

    • Optional cancellable: Gio.Cancellable

      optional #GCancellable object, %NULL to ignore.

    • Optional callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied

    Returns void

  • Initialize the user's pin on this slot that this session is opened on. According to the PKCS#11 standards, the session must be logged in with the CKU_SO user type.

    This call may block for an indefinite period.

    Parameters

    • pin: Uint8Array

      the user's PIN, or %NULL for protected authentication path

    • cancellable: Gio.Cancellable

      Optional cancellation object, or %NULL.

    Returns boolean

  • Initialize the user's pin on this slot that this session is opened on. According to the PKCS#11 standards, the session must be logged in with the CKU_SO user type.

    This call will return immediately and completes asynchronously.

    Parameters

    • pin: Uint8Array

      the user's PIN, or %NULL for protected authentication path

    • cancellable: Gio.Cancellable

      Optional cancellation object, or %NULL.

    • callback: AsyncReadyCallback

      Called when the operation completes.

    Returns void

  • Get the result of initializing a user's PIN.

    Parameters

    • result: AsyncResult

      The result passed to the callback.

    Returns boolean

  • isFloating(): boolean
  • login(userType: number, pin: Uint8Array, cancellable: Gio.Cancellable): boolean
  • Login the user on the session. This call may block for an indefinite period.

    Parameters

    • userType: number

      The type of login user.

    • pin: Uint8Array

      the user's PIN, or %NULL for protected authentication path

    • cancellable: Gio.Cancellable

      Optional cancellation object, or %NULL.

    Returns boolean

  • Login the user on the session. This call will return immediately and completes asynchronously.

    Parameters

    • userType: number

      The type of login user.

    • pin: Uint8Array

      the user's PIN, or %NULL for protected authentication path

    • cancellable: Gio.Cancellable

      Optional cancellation object, or %NULL.

    • callback: AsyncReadyCallback

      Called when the operation completes.

    Returns void

  • Get the result of a login operation.

    Parameters

    • result: AsyncResult

      The result passed to the callback.

    Returns boolean

  • Login the user on the session requesting the password interactively when necessary. This call may block for an indefinite period.

    Parameters

    • userType: number

      the type of login user

    • interaction: TlsInteraction

      interaction to request PIN when necessary

    • cancellable: Gio.Cancellable

      optional cancellation object, or %NULL

    Returns boolean

  • Login the user on the session prompting for passwords interactively when necessary. This call will return immediately and completes asynchronously.

    Parameters

    • userType: number

      the type of login user

    • interaction: TlsInteraction

      interaction to request PIN when necessary

    • cancellable: Gio.Cancellable

      optional cancellation object, or %NULL

    • callback: AsyncReadyCallback

      called when the operation completes

    Returns void

  • Get the result of a login operation.

    Parameters

    Returns boolean

  • Log out of the session. This call may block for an indefinite period.

    Parameters

    Returns boolean

  • Log out of the session. This call returns immediately and completes asynchronously.

    Parameters

    Returns void

  • Get the result of logging out of a session.

    Parameters

    • result: AsyncResult

      The result passed to the callback.

    Returns boolean

  • notify(propertyName: string): 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

    • propertyName: 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.:

      enum
    {
    PROP_0,
    PROP_FOO,
    PROP_LAST
    };

    static GParamSpec *properties[PROP_LAST];

    static void
    my_object_class_init (MyObjectClass *klass)
    {
    properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
    0, 100,
    50,
    G_PARAM_READWRITE);
    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

    • pspec: ParamSpec

      the #GParamSpec of a property installed on the class of object.

    Returns void

  • off(sigName: "discard-handle", callback: Session_DiscardHandleSignalCallback): EventEmitter
  • off(sigName: "notify::app-data", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::handle", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::interaction", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::module", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::opening-flags", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::options", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::slot", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: string, callback: ((...args: any[]) => void)): EventEmitter
  • Parameters

    Returns EventEmitter

  • Parameters

    • sigName: "notify::app-data"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::handle"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::interaction"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::module"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::opening-flags"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::options"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::slot"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • on(sigName: "discard-handle", callback: Session_DiscardHandleSignalCallback, after?: boolean): EventEmitter
  • on(sigName: "notify::app-data", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::handle", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::interaction", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::module", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::opening-flags", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::options", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::slot", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: string, callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • Parameters

    Returns EventEmitter

  • Parameters

    • sigName: "notify::app-data"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::handle"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::interaction"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::module"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::opening-flags"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::options"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::slot"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • once(sigName: "discard-handle", callback: Session_DiscardHandleSignalCallback, after?: boolean): EventEmitter
  • once(sigName: "notify::app-data", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::handle", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::interaction", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::module", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::opening-flags", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::options", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::slot", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: string, callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • Parameters

    Returns EventEmitter

  • Parameters

    • sigName: "notify::app-data"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::handle"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::interaction"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::module"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::opening-flags"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::options"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::slot"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • 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

  • 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

  • runDispose(): void
  • Releases all references to other objects. This can be used to break reference cycles.

    This function should only be called from object system implementations.

    Returns void

  • setData(key: string, data?: object): void
  • 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 #GQuark 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 #GQuark storage growing unbounded.

    Parameters

    • key: string

      name of the key

    • Optional data: object

      data to associate with that key

    Returns void

  • Set the interaction object on this session, which is used to prompt for pins and the like.

    Parameters

    Returns void

  • setPin(oldPin: Uint8Array, newPin: Uint8Array, cancellable: Gio.Cancellable): boolean
  • Change the user's pin on this slot that this session is opened on.

    This call may block for an indefinite period.

    Parameters

    • oldPin: Uint8Array

      the user's old PIN, or %NULL for protected authentication path.

    • newPin: Uint8Array

      the user's new PIN, or %NULL for protected authentication path

    • cancellable: Gio.Cancellable

      Optional cancellation object, or %NULL.

    Returns boolean

  • Change the user's pin on this slot that this session is opened on.

    This call will return immediately and completes asynchronously.

    Parameters

    • oldPin: Uint8Array

      the user's old PIN, or %NULL for protected authentication path

    • nOldPin: number

      the length of the old PIN

    • newPin: Uint8Array

      the user's new PIN, or %NULL for protected authentication path

    • cancellable: Gio.Cancellable

      Optional cancellation object, or %NULL.

    • callback: AsyncReadyCallback

      Called when the operation completes.

    Returns void

  • Get the result of changing a user's PIN.

    Parameters

    • result: AsyncResult

      The result passed to the callback.

    Returns boolean

  • setProperty(propertyName: string, value?: any): void
  • Sets a property on an object.

    Parameters

    • propertyName: string

      the name of the property to set

    • Optional value: any

      the value

    Returns void

  • Sign data in a mechanism specific manner. This call may block for an indefinite period.

    Parameters

    • key: Gck.Object

      The key to sign with.

    • mechType: number

      The mechanism type to use for signing.

    • input: Uint8Array

      data to sign

    • cancellable: Gio.Cancellable

      Optional cancellation object, or %NULL

    Returns Uint8Array

  • Sign data in a mechanism specific manner. This call will return immediately and complete asynchronously.

    Parameters

    • key: Gck.Object

      The key to sign with.

    • mechanism: Mechanism

      The mechanism type and parameters to use for signing.

    • input: Uint8Array

      data to sign

    • cancellable: Gio.Cancellable

      A GCancellable which can be used to cancel the operation.

    • callback: AsyncReadyCallback

      Called when the operation completes.

    Returns void

  • Get the result of an signing operation.

    Parameters

    • result: AsyncResult

      The result object passed to the callback.

    Returns Uint8Array

  • Sign data in a mechanism specific manner. This call may block for an indefinite period.

    Parameters

    • key: Gck.Object

      The key to sign with.

    • mechanism: Mechanism

      The mechanism type and parameters to use for signing.

    • input: Uint8Array

      data to sign

    • nResult: number

      location to store the length of the result data

    • cancellable: Gio.Cancellable

      A GCancellable which can be used to cancel the operation.

    Returns number

  • stealData(key?: string): object
  • Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

    Parameters

    • Optional key: string

      name of the key

    Returns object

  • stealQdata(quark: number): object
  • 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 #GQuark, naming the user data pointer

    Returns object

  • thawNotify(): void
  • 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::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

  • unref(): 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 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 instance. Use g_clear_object() for this.

    Returns void

  • Unwrap a key from a byte stream. This call may block for an indefinite period.

    If attrs is a floating reference, it is consumed.

    Parameters

    • wrapper: Gck.Object

      The key to use for unwrapping.

    • mechType: number

      The mechanism to use for unwrapping.

    • input: Uint8Array

      the wrapped data as a byte stream

    • attrs: Attributes

      Additional attributes for the unwrapped key.

    • cancellable: Gio.Cancellable

      Optional cancellation object, or %NULL.

    Returns Gck.Object

  • Unwrap a key from a byte stream. This call will return immediately and complete asynchronously.

    If attrs is a floating reference, it is consumed.

    Parameters

    • wrapper: Gck.Object

      The key to use for unwrapping.

    • mechanism: Mechanism

      The mechanism to use for unwrapping.

    • input: Uint8Array

      the wrapped data as a byte stream

    • attrs: Attributes

      Additional attributes for the unwrapped key.

    • cancellable: Gio.Cancellable

      Optional cancellation object or %NULL.

    • callback: AsyncReadyCallback

      Called when the operation completes.

    Returns void

  • Unwrap a key from a byte stream. This call may block for an indefinite period.

    If attrs is a floating reference, it is consumed.

    Parameters

    • wrapper: Gck.Object

      The key to use for unwrapping.

    • mechanism: Mechanism

      The mechanism to use for unwrapping.

    • input: Uint8Array

      the wrapped data as a byte stream

    • attrs: Attributes

      Additional attributes for the unwrapped key.

    • cancellable: Gio.Cancellable

      Optional cancellation object, or %NULL.

    Returns Gck.Object

  • verify(key: Gck.Object, mechType: number, input: Uint8Array, signature: Uint8Array, cancellable: Gio.Cancellable): boolean
  • Verify data in a mechanism specific manner. This call may block for an indefinite period.

    Parameters

    • key: Gck.Object

      The key to verify with.

    • mechType: number

      The mechanism type to use for verifying.

    • input: Uint8Array

      data to verify

    • signature: Uint8Array

      the signature

    • cancellable: Gio.Cancellable

      Optional cancellation object, or %NULL

    Returns boolean

  • Verify data in a mechanism specific manner. This call returns immediately and completes asynchronously.

    Parameters

    • key: Gck.Object

      The key to verify with.

    • mechanism: Mechanism

      The mechanism type and parameters to use for signing.

    • input: Uint8Array

      data to verify

    • signature: Uint8Array

      the signature

    • cancellable: Gio.Cancellable

      A GCancellable which can be used to cancel the operation.

    • callback: AsyncReadyCallback

      Called when the operation completes.

    Returns void

  • Get the result of an verify operation.

    Parameters

    • result: AsyncResult

      The result object passed to the callback.

    Returns boolean

  • Verify data in a mechanism specific manner. This call may block for an indefinite period.

    Parameters

    • key: Gck.Object

      The key to verify with.

    • mechanism: Mechanism

      The mechanism type and parameters to use for signing.

    • input: Uint8Array

      data to verify

    • signature: Uint8Array

      the signature

    • cancellable: Gio.Cancellable

      A GCancellable which can be used to cancel the operation.

    Returns boolean

  • watchClosure(closure: TClosure<any, any>): 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

    • closure: TClosure<any, any>

      #GClosure to watch

    Returns void

  • Wrap a key into a byte stream. This call may block for an indefinite period.

    Parameters

    • wrapper: Gck.Object

      The key to use for wrapping.

    • mechType: number

      The mechanism type to use for wrapping.

    • wrapped: Gck.Object

      The key to wrap.

    • cancellable: Gio.Cancellable

      A #GCancellable or %NULL

    Returns Uint8Array

  • Wrap a key into a byte stream. This call will return immediately and complete asynchronously.

    Parameters

    Returns void

  • Get the result of a wrap key operation.

    Parameters

    • result: AsyncResult

      The async result passed to the callback.

    Returns Uint8Array

  • Wrap a key into a byte stream. This call may block for an indefinite period.

    Parameters

    • wrapper: Gck.Object

      The key to use for wrapping.

    • mechanism: Mechanism

      The mechanism to use for wrapping.

    • wrapped: Gck.Object

      The key to wrap.

    • cancellable: Gio.Cancellable

      Optional cancellation object, or %NULL.

    Returns Uint8Array

  • compatControl(what: number, data: object): number
  • Initialize a session object from a raw PKCS#11 session handle. Usually one would use the [methodSlot.open_session] function to create a session.

    Parameters

    • slot: Gck.Slot

      The slot which the session belongs to.

    • sessionHandle: number

      the raw PKCS#11 handle of the session

    • options: SessionOptions

      Session options. Those which are used during opening a session have no effect.

    Returns Gck.Session

  • Find the #GParamSpec with the given name for an interface. Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    • propertyName: string

      name of a property to look up.

    Returns ParamSpec

  • 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 #GParamSpec, 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 #GTypeInfo.) 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

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface.

    • pspec: ParamSpec

      the #GParamSpec for the new property

    Returns void

  • Lists the properties of an interface.Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    Returns ParamSpec[]

  • Creates a new instance of a #GObject subtype and sets its properties.

    Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.

    Parameters

    • objectType: GType<unknown>

      the type id of the #GObject subtype to instantiate

    • parameters: GObject.Parameter[]

      an array of #GParameter

    Returns GObject.Object

  • Open a session on the slot. This call will return immediately and complete asynchronously.

    Parameters

    Returns void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method