kc_kset_str - Key sets of the application

The data structure kc_kset_str is defined for the object type KC_KSET. With KC_GET_OBJECT, UTM returns information on a key set in kc_kset_str.

The key or access codes of the application that were defined for data access control are grouped together in a logical key set.

You can assign a key set to a user, an LTERM partner, an LTERM pool, an (OSI-)LPAP partner or an access list. This controls access to TAC objects, for example. In this manner, the key set and the access privileges associated with it are made available to the clients or the partner application after establishing the logical connection or to the user after signing on to the application (see also the openUTM manual “Concepts und Functions”).

The key sets can be created with KC_CREATE_OBJECT, deleted with LKC_DELETE_OBJECT, or dynamically modified with KC_MOFDIFY_OBJECT. Which key set is assigned to a client, a partner application or a user is returned in the data structure of the object in the kset field.

KDCDEF implicitly creates the KDCAPLKS key set, which already contains all key codes.

mod1	Data structure kc_kset_str
-	char ks_name[8];
-	char master;
x(GPD)	char keys[4000];
-	char ks_deleted;

¹ Field contents can be modified with KC_MODIFY_OBJECT, see "obj_type=KC_KSET"

The fields in the data structure have the following meanings:

ks_name
	Contains the name of the key sets. It is specified in KSET when the key set is created with KC_CREATE_OBJECT object type KC_KSET or at KDCDEF generation (KSET statement).
master
	Specifies if the key set is a master key set. A master key set contains all key or access codes needed to access the objects of the application, i.e. all key codes between 1 and the maximum specified in the KDCDEF generation in MAX KEYVALUE.
	'Y'	The key set is a master key set.
	'N'	The key set is not a master key set (default).
keys	Specifies the key or access codes that belong to the key set. A key or access code is an integer between 1 and the KEYVALUE set during the KDCDEF generation in the MAX statement. KEYVALUE is the largest possible key or access code of the application. KEYVALUE can lie between 1 and 4000. keys consists of 4000 field elements, keys[0] to keys[3999]. The contents of the field elements are interpreted as follows:
	keys[0] =
		'0': The key/access code 1 does not belong to this key set. '1': The key/access code 1 belongs to this key set.
	keys[n] =
		'0': The key/access code n+1 does not belong to this key set. '1': The key/access code n+1 belongs to this key set.
	keys[3999] =
		'0': The key/access code 4000 does not belong to this key set. '1': The key/access code 4000 belongs to this key set.
ks_deleted
	Indicates whether the key set was deleted from the configuration dynamically:
	'Y'	The key set is deleted.
	'N'	The key set is not deleted.