1Tspi_Context_CreateOTbCjGecSto(f3t)ware Stack Developer's RTesfpeir_eCnocnetext_CreateObject(3)
2
3
4

NAME

6       Tspi_Context_CreateObject  - create an empty object and return a handle
7       to that object.
8

SYNOPSIS

10       #include <tss/platform.h>
11       #include <tss/tcpa_defines.h>
12       #include <tss/tcpa_typedef.h>
13       #include <tss/tcpa_struct.h>
14       #include <tss/tss_typedef.h>
15       #include <tss/tss_structs.h>
16       #include <tss/tspi.h>
17
18       TSS_RESULT Tspi_Context_CreateObject(TSS_HCONTEXT hContext,  TSS_FLAG     objectType,
19                                            TSS_FLAG     initFlags, TSS_HOBJECT* phObject);
20
21

DESCRIPTION

23       TSS_Context_CreateObject creates and initializes an empty object of the
24       specified  type and returns a handle addressing that object. The object
25       is bound to an already opened context hContext.
26

PARAMETERS

28   hContext
29       The handle of the context object.
30
31   objectType
32       Flag indicating the object type to create. Possible types are:
33
34       TSS_OBJECT_TYPE_POLICY - a policy object.
35
36       TSS_OBJECT_TYPE_ENCDATA - an encrypted data object  (either  sealed  or
37       bound data).
38
39       TSS_OBJECT_TYPE_RSAKEY - an RSA key.
40
41       TSS_OBJECT_TYPE_PCRS - a PCR composite object.
42
43       TSS_OBJECT_TYPE_HASH - a hash object.
44
45   initFlags
46       Flag  indicating  the  default attributes of the object. Attributes for
47       each type of object are:
48
49       Policy:
50               TSS_POLICY_USAGE - a usage policy (for authorization to use  an
51              object).
52               TSS_POLICY_MIGRATION - a migration policy.
53
54       Encrypted data objects:
55               TSS_ENCDATA_SEAL - A data object used for a Seal operation.
56               TSS_ENCDATA_BIND - A data object used for a Bind operation.
57               TSS_ENCDATA_LEGACY - A data object for a bind operation using a
58              legacy key.
59
60       RSA Keys:
61               TSS_KEY_SIZE_DEFAULT - Use the default  key  size  of  the  TCS
62              you're connected to.
63               TSS_KEY_SIZE_512 - Create a 512 bit key.
64               TSS_KEY_SIZE_1024 - Create a 1024 bit key.
65               TSS_KEY_SIZE_2048 - Create a 2048 bit key.
66               TSS_KEY_SIZE_4096 - Create a 4096 bit key.
67               TSS_KEY_SIZE_8192 - Create a 8192 bit key.
68               TSS_KEY_SIZE_16384 - Create a 16384 bit key.
69               TSS_KEY_TYPE_STORAGE - Create a storage key. (Used to wrap oth‐
70              er keys).
71               TSS_KEY_TYPE_SIGNING - Create a signing key.
72               TSS_KEY_TYPE_BIND - Create a binding key. (Used to encrypt  da‐
73              ta).
74               TSS_KEY_TYPE_IDENTITY  -  Create  an identity key. (Used for an
75              identity).
76               TSS_KEY_TYPE_LEGACY - Create a legacy key.  (Can  be  used  for
77              signing and binding, created from data external to a TSS).
78               TSS_KEY_TYPE_AUTHCHANGE  -  Create  an  ephemeral  key  used to
79              change authorization values.
80               TSS_KEY_VOLATILE - Create a volatile key. (Must be unloaded  at
81              startup).
82               TSS_KEY_NON_VOLATILE  -  Create a non-volatile key. (May be un‐
83              loaded at startup).
84               TSS_KEY_MIGRATABLE - Create a migratable key.
85               TSS_KEY_NOT_MIGRATABLE - Create a non-migratable key. [DEFAULT]
86               TSS_KEY_AUTHORIZATION - Key will require authorization.
87               TSS_KEY_NO_AUTHORIZATION - Key will not require  authorization.
88              [DEFAULT]
89               TSS_KEY_EMPTY_KEY  -  Key template which will be returned as an
90              object with very few attributes.
91
92
93       PCR composite objects:
94               None.
95
96       Hash objects:
97               TSS_HASH_SHA1 - a hash object of type SHA-1.
98               TSS_HASH_OTHER - a hash object of type other than SHA-1.
99
100   phObject
101       The handle of the object to be created.
102
103

RETURN CODES

105       Tspi_Context_CreateObject returns TSS_SUCCESS on success, otherwise one
106       of the following values are returned:
107
108       TSS_E_INVALID_HANDLE  -  Either hContext or phObject is an invalid han‐
109       dle.
110
111       TSS_E_INTERNAL_ERROR - An error occurred internal to the TSS.
112
113

CONFORMING TO

115       Tspi_Context_CreateObject conforms to the Trusted Computing Group Soft‐
116       ware Specification version 1.1 Golden
117

SEE ALSO

119       Tspi_Context_CloseObject(3).
120
121
122
123TSS 1.1                           2004-05-26      Tspi_Context_CreateObject(3)