SAP ABAP Class CL_SECSTORE_FS (Kernel-Wrapper for SecStoreFS)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SEC (Application Component) Security
     ⤷ SECSTORE (Package) Secure Storage

Properties

Class	CL_SECSTORE_FS
Short Description	Kernel-Wrapper for SecStoreFS
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	SECSTORE	Secure Storage
Created	20120404	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_SECSTORE_FS has no interface implemented.

Friends

Class CL_SECSTORE_FS has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CON_KEY_TYPE_3DES	Constant	Public	☐	Type reference (TYPE)	RSECSSFS_KEY_TYPE	1	Key type in the secure storage	20120404
2	CON_LIST_STATUS_BINARY_ENCR	Constant	Public	☐	Type reference (TYPE)	RSECSSFS_RECORD_STATUS	4	List status: Encrypted Binary Value	20120515
3	CON_LIST_STATUS_BINARY_PLAIN	Constant	Public	☐	Type reference (TYPE)	RSECSSFS_RECORD_STATUS	3	List status: Unencrypted Binary Value	20120515
4	CON_LIST_STATUS_ERROR	Constant	Public	☐	Type reference (TYPE)	RSECSSFS_RECORD_STATUS	6	List status: Error	20120515
5	CON_LIST_STATUS_TEXT_ENCR	Constant	Public	☐	Type reference (TYPE)	RSECSSFS_RECORD_STATUS	2	List status: Encrypted Text Value	20120515
6	CON_LIST_STATUS_TEXT_PLAIN	Constant	Public	☐	Type reference (TYPE)	RSECSSFS_RECORD_STATUS	1	List status: Unencrypted Text Value	20120515
7	CON_LIST_STATUS_WRONG_KEY	Constant	Public	☐	Type reference (TYPE)	RSECSSFS_RECORD_STATUS	5	List status: Wrong Encryption Key	20120515
8	MO_INSTANCE	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_SECSTORE_FS		Kernel-Wrapper for SecStoreFS	20120423
9	MS_TEST_ENVIRONMENT	Static Attribute	Private	☐	Type reference (TYPE)	RSECSSFS_TEST_ENVIRONMENT_S		Set via FRIEND from unit test	20120404

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ACTIVATE_TEST_MODE	Static method	Public	Method	Usage outside package SECSTORE forbidden!	20120514
2	CHANGE_KEY	Instance method	Public	Method	Change Encryption Key	20120404
3	CHECK_KEY_COMPOUND	Static method	Public	Method	Check Key Compound for correct structure	20120507
4	COMPACT	Instance method	Public	Method	Compact Contents	20120404
5	DELETE_RECORD	Instance method	Public	Method	Delete Record from SecStoreFS	20120404
6	GENERATE_KEY	Static method	Public	Method	Generate Key for SecStoreFS/SecStoreDB	20120404
7	GET_INSTANCE	Static method	Public	Method	Instance Factory	20120423
8	GET_RECORD	Instance method	Public	Method	Get (unencrypted) record	20120417
9	GET_TEST_ENVIRONMENT	Static method	Public	Method	Usage outside package SECSTORE forbidden!	20120514
10	IS_IN_TEST_MODE	Static method	Public	Method	Indicator that test mode active	20120514
11	LIST_RECORDS	Instance method	Public	Method	List Records in SecStoreFS	20120404
12	PUT_RECORD	Instance method	Public	Method	Put Record into SecStoreFS	20120404
13	REMOVE_FILES	Instance method	Public	Method	Remove files of SecStoreFS	20120404
14	_CHECK_KEY_COMPOUND	Static method	Private	Method	Kernel: Wrapper for Key Compound Check	20120507
15	_CONVERT	Static method	Private	Method	Kernel: Wrapper for Convert	20120404
16	_GENERATE_KEY	Static method	Private	Method	Kernel: Generate Key for SecStoreFS/SecStoreDB	20120404
17	_GET_RECORD	Static method	Private	Method	Kernel: Wrapper for Get	20120417
18	_LIST_RECORDS	Static method	Private	Method	Kernel: List Records in SecStoreFS	20120404
19	_PUT_RECORD	Static method	Private	Method	Kernel: Wrapper for Put/Delete	20120404
20	_REMOVE_FILES	Static method	Private	Method	Kernel: Wrapper for file deletion	20120404

Events

Class CL_SECSTORE_FS has no event.

Types

Class CL_SECSTORE_FS has no local type.

Method Signatures

Method ACTIVATE_TEST_MODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_TEST_ENVIRONMENT	Call by reference	☑	Type reference (TYPE)	RSECSSFS_TEST_ENVIRONMENT_S		Kernel API of RSecSSFs: Test Environment per Call	20120629

Method ACTIVATE_TEST_MODE on class CL_SECSTORE_FS has no exception.

Method CHANGE_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IF_NEW_KEY	Call by reference	☐	Type reference (TYPE)	XSTRING		New encryption key	20120404

#	Exception	Resumable	Description	Created on
1	CX_SECSTORE_FS	☐	Exception from SecStoreFS	20120404

Method CHECK_KEY_COMPOUND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IF_KEY_COMPOUND	Call by reference	☐	Type reference (TYPE)	XSTRING		Key Compound	20120507
2	Importing	IF_KEY_ID	Call by reference	☑	Type reference (TYPE)	STRING		Key ID (not supplied = ignored)	20120507

#	Exception	Resumable	Description	Created on
1	CX_SECSTORE_FS	☐	Exception from SecStoreFS	20120507

Method COMPACT Signature

Method COMPACT on class CL_SECSTORE_FS has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_SECSTORE_FS	☐	Exception from SecStoreFS	20120404

Method DELETE_RECORD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IF_KEY	Call by reference	☐	Type reference (TYPE)	STRING		Record Key	20120404

#	Exception	Resumable	Description	Created on
1	CX_SECSTORE_FS	☐	Exception from SecStoreFS	20120404

Method GENERATE_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EF_KEY_COMPOUND	Call by reference	☐	Type reference (TYPE)	XSTRING		Key Compound	20120404
2	Exporting	EF_KEY_ID	Call by reference	☐	Type reference (TYPE)	STRING		Generated/Used Key ID	20120404
3	Importing	IF_KEY_ID	Call by reference	☑	Type reference (TYPE)	STRING		Key ID Proposal (not supplied = generate)	20120404
4	Importing	IF_KEY_TYPE	Call by reference	☐	Type reference (TYPE)	RSECSSFS_KEY_TYPE	CON_KEY_TYPE_3DES	Key type in the secure storage	20120404

#	Exception	Resumable	Description	Created on
1	CX_SECSTORE_FS	☐	Exception from SecStoreFS	20120404

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	CL_SECSTORE_FS		Kernel-Wrapper for SecStoreFS	20120423

Method GET_INSTANCE on class CL_SECSTORE_FS has no exception.

Method GET_RECORD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EF_IS_BINARY	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Value is binary value (EF_VALUEX)	20120417
2	Exporting	EF_VALUE	Call by reference	☐	Type reference (TYPE)	STRING		Record Value (Text)	20120417
3	Exporting	EF_VALUEX	Call by reference	☐	Type reference (TYPE)	XSTRING		Record Value (Binary)	20120417
4	Importing	IF_KEY	Call by reference	☐	Type reference (TYPE)	STRING		Record Key	20120417

#	Exception	Resumable	Description	Created on
1	CX_SECSTORE_FS	☐	Exception from SecStoreFS	20120417

Method GET_TEST_ENVIRONMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RS_TEST_ENVIRONMENT	Value transfer	☐	Type reference (TYPE)	RSECSSFS_TEST_ENVIRONMENT_S		Kernel API of RSecSSFs: Test Environment per Call	20120514

Method GET_TEST_ENVIRONMENT on class CL_SECSTORE_FS has no exception.

Method IS_IN_TEST_MODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RF_TEST_MODE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20120514

Method IS_IN_TEST_MODE on class CL_SECSTORE_FS has no exception.

Method LIST_RECORDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EF_DATAFILE	Call by reference	☐	Type reference (TYPE)	STRING		Location of the data file	20120404
2	Exporting	EF_KEYFILE	Call by reference	☐	Type reference (TYPE)	STRING		Location of the key file	20120404
3	Exporting	EF_NUMBER_ACTIVE_RECORDS	Call by reference	☐	Type reference (TYPE)	I		Number of records in the prefix	20120404
4	Exporting	EF_NUMBER_DELETED_RECORDS	Call by reference	☐	Type reference (TYPE)	I		Number of deleted records in the prefix	20120404
5	Exporting	ET_RECORDS	Call by reference	☐	Type reference (TYPE)	RSECSSFS_LIST_RECORDS_T		Kernel API of RSecSSFs: List Records result table type	20120404
6	Importing	IF_PREFIX	Call by reference	☑	Type reference (TYPE)	STRING		Record key prefix	20120404

#	Exception	Resumable	Description	Created on
1	CX_SECSTORE_FS	☐	Exception from SecStoreFS	20120404

Method PUT_RECORD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IF_IS_BINARY	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Store binary value (use IF_VALUEX)	20120404
2	Importing	IF_KEY	Call by reference	☐	Type reference (TYPE)	STRING		Record Key	20120404
3	Importing	IF_STORE_PLAINTEXT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Store unencrypted	20120404
4	Importing	IF_VALUE	Call by reference	☑	Type reference (TYPE)	STRING		Record Value (Text)	20120404
5	Importing	IF_VALUEX	Call by reference	☑	Type reference (TYPE)	XSTRING		Record Value (Binary)	20120404

#	Exception	Resumable	Description	Created on
1	CX_SECSTORE_FS	☐	Exception from SecStoreFS	20120404

Method REMOVE_FILES Signature

Method REMOVE_FILES on class CL_SECSTORE_FS has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_SECSTORE_FS	☐	Exception from SecStoreFS	20120404

Method _CHECK_KEY_COMPOUND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IF_KEY_COMPOUND	Call by reference	☐	Type reference (TYPE)	XSTRING		Key Compound	20120507
2	Importing	IF_KEY_ID	Call by reference	☑	Type reference (TYPE)	STRING		Key ID	20120507

#	Exception	Resumable	Description	Created on
1	CX_SECSTORE_FS	☐	Exception from SecStoreFS	20120507

Method _CONVERT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EF_RECS_PLAINTEXT	Call by reference	☐	Type reference (TYPE)	I			20120404
2	Exporting	EF_RECS_SECURE_NOT_READABLE	Call by reference	☐	Type reference (TYPE)	I			20120404
3	Exporting	EF_RECS_SECURE_READABLE	Call by reference	☐	Type reference (TYPE)	I			20120404
4	Importing	IF_NEW_KEY	Call by reference	☑	Type reference (TYPE)	XSTRING			20120404
5	Importing	IF_OLD_KEY	Call by reference	☑	Type reference (TYPE)	XSTRING			20120404
6	Importing	IS_TEST_ENVIRONMENT	Call by reference	☑	Type reference (TYPE)	RSECSSFS_TEST_ENVIRONMENT_S		Kernel API of RSecSSFs: Test Environment per Call	20120404

#	Exception	Resumable	Description	Created on
1	CX_SECSTORE_FS	☐	Exception from SecStoreFS	20120404

Method _GENERATE_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EF_KEY_COMPOUND	Call by reference	☐	Type reference (TYPE)	XSTRING		Key Compound	20120404
2	Exporting	EF_KEY_ID	Call by reference	☐	Type reference (TYPE)	STRING		Generated/Used Key ID	20120404
3	Importing	IF_KEY_ID	Call by reference	☑	Type reference (TYPE)	STRING		Key ID Proposal (empty = generate)	20120404
4	Importing	IF_KEY_TYPE	Call by reference	☑	Type reference (TYPE)	RSECSSFS_KEY_TYPE		Key type in the secure storage	20120404

#	Exception	Resumable	Description	Created on
1	CX_SECSTORE_FS	☐	Exception from SecStoreFS	20120404

Method _GET_RECORD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EF_IS_BINARY	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20120417
2	Exporting	EF_VALUE	Call by reference	☐	Type reference (TYPE)	STRING			20120417
3	Exporting	EF_VALUEX	Call by reference	☐	Type reference (TYPE)	XSTRING			20120417
4	Importing	IF_KEY	Call by reference	☐	Type reference (TYPE)	STRING			20120417
5	Importing	IS_TEST_ENVIRONMENT	Call by reference	☑	Type reference (TYPE)	RSECSSFS_TEST_ENVIRONMENT_S		Kernel API of RSecSSFs: Test Environment per Call	20120417

#	Exception	Resumable	Description	Created on
1	CX_SECSTORE_FS	☐	Exception from SecStoreFS	20120417

Method _LIST_RECORDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EF_DATAFILE	Call by reference	☐	Type reference (TYPE)	STRING		Location of the data file	20120404
2	Exporting	EF_KEYFILE	Call by reference	☐	Type reference (TYPE)	STRING		Location of the key file	20120404
3	Exporting	EF_NUMBER_ACTIVE_RECORDS	Call by reference	☐	Type reference (TYPE)	I		Number of records in the prefix	20120404
4	Exporting	EF_NUMBER_DELETED_RECORDS	Call by reference	☐	Type reference (TYPE)	I		Number of deleted records in the prefix	20120404
5	Exporting	ET_RECORDS	Call by reference	☐	Type reference (TYPE)	RSECSSFS_LIST_RECORDS_T		Kernel API of RSecSSFs: List Records result table type	20120404
6	Importing	IF_PREFIX	Call by reference	☑	Type reference (TYPE)	STRING		Record key prefix	20120404
7	Importing	IS_TEST_ENVIRONMENT	Call by reference	☑	Type reference (TYPE)	RSECSSFS_TEST_ENVIRONMENT_S		Kernel API of RSecSSFs: Test Environment per Call	20120404

#	Exception	Resumable	Description	Created on
1	CX_SECSTORE_FS	☐	Exception from SecStoreFS	20120404

Method _PUT_RECORD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IF_IS_BINARY	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL			20120404
2	Importing	IF_KEY	Call by reference	☐	Type reference (TYPE)	STRING			20120404
3	Importing	IF_STORE_PLAINTEXT	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL			20120404
4	Importing	IF_VALUE	Call by reference	☑	Type reference (TYPE)	STRING			20120404
5	Importing	IF_VALUEX	Call by reference	☑	Type reference (TYPE)	XSTRING			20120404
6	Importing	IS_TEST_ENVIRONMENT	Call by reference	☑	Type reference (TYPE)	RSECSSFS_TEST_ENVIRONMENT_S		Kernel API of RSecSSFs: Test Environment per Call	20120404

#	Exception	Resumable	Description	Created on
1	CX_SECSTORE_FS	☐	Exception from SecStoreFS	20120404

Method _REMOVE_FILES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_TEST_ENVIRONMENT	Call by reference	☐	Type reference (TYPE)	RSECSSFS_TEST_ENVIRONMENT_S		Kernel API of RSecSSFs: Test Environment per Call	20120404

#	Exception	Resumable	Description	Created on
1	CX_SECSTORE_FS	☐	Exception from SecStoreFS	20120404

History

Last changed by/on	SAP	20130531
SAP Release Created in	740