PKCS11Spec (IAIK PKCS#11 Provider API Documentation)

java.lang.Object
- iaik.pkcs.pkcs11.provider.spec.PKCS11Spec

All Implemented Interfaces:

java.security.spec.KeySpec

Direct Known Subclasses:

PKCS11KeyAgreementSpec, PKCS11KeyGenerationSpec, PKCS11KeyPairGenerationSpec, PKCS11KeySpec, PKCS11OAEPParameterSpec, PKCS11UnwrapKeySpec
```
public abstract class PKCS11Spec
extends java.lang.Object
implements java.security.spec.KeySpec
```
This is a key specification object. It carries the actual key spec and additional data needed for PKCS#11.

Field Summary

Fields
Modifier and Type	Field and Description
`protected TokenManager`	`tokenManager_` The manager to handle the token.
`protected static int`	`USE_PUBLIC_ROLE` The Constant USE_PUBLIC_ROLE.
`static boolean`	`USE_PUBLIC_SESSION` Deprecated.
`static boolean`	`USE_READ_ONLY_SESSION` Deprecated.
`static boolean`	`USE_READ_WRITE_SESSION` Deprecated.
`protected static int`	`USE_SO_ROLE` The Constant USE_SO_ROLE.
`protected static int`	`USE_USER_ROLE` The Constant USE_USER_ROLE.
`static boolean`	`USE_USER_SESSION` Deprecated.
`protected char[]`	`usePin_` The pin_.
`protected int`	`useRole_` The role_.
`protected boolean`	`useROSession_` Indicates, if the key should be generated using a read-only session.

Constructor Summary

Constructors
Constructor and Description

PKCS11Spec()

PKCS11Spec(TokenManager tokenManager, boolean useROSession, boolean useUserSession)
Deprecated.

Constructors
Constructor and Description
`PKCS11Spec()`
`PKCS11Spec(TokenManager tokenManager, boolean useROSession, boolean useUserSession)` Deprecated.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`char[]`	`getPin()` Gets the pin.
`protected int`	`getRole()` Gets the role.
`TokenManager`	`getTokenManager()` Get the manager to handle the token.
`boolean`	`isUseAnonymousRole()` Checks if the task should use an anonymous session.
`boolean`	`isUseROSession()` Check if the key should be generated using a read-only session.
`boolean`	`isUseRwSession()` Checks if the task should use a rw session.
`boolean`	`isUseSORole()` Checks if the task should use a Security Officer (SO) session.
`boolean`	`isUseUserRole()` Checks if the task should use a user session.
`boolean`	`isUseUserSession()` Check if the key should be generated using a user session.
`PKCS11Spec`	`setPin(char[] pin)` Allows to preset the required pin for User and SO session types.
`protected void`	`setRole(int role)` Sets the role.
`PKCS11Spec`	`setTokenManager(TokenManager tokenManager)` When there are multiple PKCS11-tokens in use, use this method to specify which `TokenManager` should be used.
`PKCS11Spec`	`setUseAnonymousRole(boolean rwAccess)` Use an anonymous (aka public) session when performing the task.
`PKCS11Spec`	`setUseSORole()` Use a Security Officer (SO) session when performing the task.
`PKCS11Spec`	`setUseUserRole(boolean rwAccess)` Use a user session when performing the task.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - USE_READ_ONLY_SESSION
```
public static boolean USE_READ_ONLY_SESSION
```
    Deprecated.
    
    Constant for the useROSession_ property. Tells that a read-only session shall be used.
  - USE_READ_WRITE_SESSION
```
public static boolean USE_READ_WRITE_SESSION
```
    Deprecated.
    
    Constant for the useROSession_ property. Tells that a read-write session shall be used.
  - USE_USER_SESSION
```
public static boolean USE_USER_SESSION
```
    Deprecated.
    
    Constant for the useUserSession_ property. Tells that an user session shall be used.
  - USE_PUBLIC_SESSION
```
public static boolean USE_PUBLIC_SESSION
```
    Deprecated.
    
    Constant for the useUserSession_ property. Tells that a public session shall be used.
  - USE_SO_ROLE
```
protected static final int USE_SO_ROLE
```
    The Constant USE_SO_ROLE.
    
    See Also:
    
    Constant Field Values
  - USE_USER_ROLE
```
protected static final int USE_USER_ROLE
```
    The Constant USE_USER_ROLE.
    
    See Also:
    
    Constant Field Values
  - USE_PUBLIC_ROLE
```
protected static final int USE_PUBLIC_ROLE
```
    The Constant USE_PUBLIC_ROLE.
    
    See Also:
    
    Constant Field Values
  - tokenManager_
```
protected TokenManager tokenManager_
```
    The manager to handle the token.
  - useROSession_
```
protected boolean useROSession_
```
    Indicates, if the key should be generated using a read-only session.
  - useRole_
```
protected int useRole_
```
    The role_.
  - usePin_
```
protected char[] usePin_
```
    The pin_.
- Constructor Detail
  - PKCS11Spec
```
public PKCS11Spec(TokenManager tokenManager,
                  boolean useROSession,
                  boolean useUserSession)
```
    Deprecated.
    
    Constructor taking several parameters that control where and how the key should be generated.
    
    Parameters:
    
    tokenManager - The manager to handle the token to generate the key on.
    
    useROSession - true (USE_READ_ONLY_SESSION), if the key should be generated using a read-only session. This is only possible for session-objects. false ( USE_READ_WRITE_SESSION) to use a read-write session.
    
    useUserSession - true (USE_USER_SESSION), if the key should be generated using a user session. This is required for private objects (key); i.e. keys that have their private flag set. false (USE_PUBLIC_SESSION) to use a public session. This will only work for public objects.
  - PKCS11Spec
```
public PKCS11Spec()
```
- Method Detail
  - setTokenManager
```
public PKCS11Spec setTokenManager(TokenManager tokenManager)
```
    When there are multiple PKCS11-tokens in use, use this method to specify which TokenManager should be used.
    
    Parameters:
    
    tokenManager - the new token manager
  - getTokenManager
```
public TokenManager getTokenManager()
```
    Get the manager to handle the token.
    
    Returns:
    
    The manager to handle the token.
    
    Postconditions:
    
    (result <> null)
  - isUseROSession
```
public boolean isUseROSession()
```
    Check if the key should be generated using a read-only session. This is only possible for session-objects.
    
    Returns:
    
    true, if the key should be generated using a read-only session. false to use a read-write session.
  - isUseUserSession
```
public boolean isUseUserSession()
```
    Check if the key should be generated using a user session. This is required for private objects (key); i.e. keys that have their private flag set.
    
    Returns:
    
    true (USE_USER_SESSION), if the key should be generated using a user session. false ( USE_PUBLIC_SESSION) to use a public session.
  - setRole
```
protected void setRole(int role)
```
    Sets the role.
    
    Parameters:
    
    role - the new role
  - setUseAnonymousRole
```
public PKCS11Spec setUseAnonymousRole(boolean rwAccess)
```
    Use an anonymous (aka public) session when performing the task.
    
    Parameters:
    
    rwAccess - whether or not rw access should be used.
    
    Returns:
    
    this (PKCS11Spec)
  - setUseUserRole
```
public PKCS11Spec setUseUserRole(boolean rwAccess)
```
    Use a user session when performing the task.
    
    Parameters:
    
    rwAccess - whether or not rw access should be used.
    
    Returns:
    
    this (PKCS11Spec)
  - setUseSORole
```
public PKCS11Spec setUseSORole()
```
    Use a Security Officer (SO) session when performing the task. A rw session will be used.
    
    Returns:
    
    this (PKCS11Spec)
  - getRole
```
protected int getRole()
```
    Gets the role.
    
    Returns:
    
    the role
  - isUseAnonymousRole
```
public boolean isUseAnonymousRole()
```
    Checks if the task should use an anonymous session.
    
    Returns:
    
    true, if yes
  - isUseUserRole
```
public boolean isUseUserRole()
```
    Checks if the task should use a user session.
    
    Returns:
    
    true, if yes
  - isUseSORole
```
public boolean isUseSORole()
```
    Checks if the task should use a Security Officer (SO) session.
    
    Returns:
    
    true, if yes
  - isUseRwSession
```
public boolean isUseRwSession()
```
    Checks if the task should use a rw session.
    
    Returns:
    
    true, if rw; false, if ro
  - setPin
```
public PKCS11Spec setPin(char[] pin)
```
    Allows to preset the required pin for User and SO session types.
    
    Parameters:
    
    pin - the pin
    
    Returns:
    
    this (PKCS11Spec)
  - getPin
```
public char[] getPin()
```
    Gets the pin.
    
    Returns:
    
    the pin. null if no pin is given.

IAIK JavaSecurity Website https://jce.iaik.tugraz.at/

IAIK at Graz University of Technology, Austria, Europe
Copyright 2001-2023 IAIK, Graz University of Technology, Inffeldgasse 16a, 8010 Graz, Austria. All Rights Reserved. Version 1.9.4

Class PKCS11Spec

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

USE_READ_ONLY_SESSION

USE_READ_WRITE_SESSION

USE_USER_SESSION

USE_PUBLIC_SESSION

USE_SO_ROLE

USE_USER_ROLE

USE_PUBLIC_ROLE

tokenManager_

useROSession_

useRole_

usePin_

Constructor Detail

PKCS11Spec

PKCS11Spec

Method Detail

setTokenManager

getTokenManager

isUseROSession

isUseUserSession

setRole

setUseAnonymousRole

setUseUserRole

setUseSORole

getRole

isUseAnonymousRole

isUseUserRole

isUseSORole

isUseRwSession

setPin

getPin