SAP ABAP Class CL_SMIME (S/MIME - API)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SEC-SSF (Application Component) Secure Store and Forward
     ⤷ SECF (Package) Secure Store & Forward (SSF) Support

Properties

Class	CL_SMIME
Short Description	S/MIME - API
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	SECF	Secure Store & Forward (SSF) Support
Created	20100618	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_SMIME has no interface implemented.

Friends

Class CL_SMIME has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_CRL_PROFILE	Constant	Public	☐	Type reference (TYPE)	CR_PROFILE	'SMIME'	Profile Name	20111017
2	CO_HASHALG_MD5	Constant	Public	☐	Type reference (TYPE)	SSFHASH	'MD5'	SSF Hash Algorithm	20110708
3	CO_HASHALG_SHA1	Constant	Public	☐	Type reference (TYPE)	SSFHASH	'SHA1'	SSF Hash Algorithm	20110708
4	CO_HASHALG_SHA256	Constant	Public	☐	Type reference (TYPE)	SSFHASH	'SHA256'	SSF Hash Algorithm	20110708
5	CO_HASHALG_SHA384	Constant	Public	☐	Type reference (TYPE)	SSFHASH	'SHA384'	SSF Hash Algorithm	20110708
6	CO_HASHALG_SHA512	Constant	Public	☐	Type reference (TYPE)	SSFHASH	'SHA512'	SSF Hash Algorithm	20110708
7	CO_PSE_CONTEXT	Constant	Public	☐	Type reference (TYPE)	PSECONTEXT	'SMIM'	Application Context of a PSE	20110801
8	CO_SMIME2_ALG_CRYPT	Constant	Private	☐	Type reference (TYPE)	SSFENCR	'DES-EDE3-CBC'	SSF Encryption Algrorithm	20110708
9	CO_SMIME2_ALG_SIGN	Constant	Private	☐	Type reference (TYPE)	SSFHASH	'SHA1'	SSF Hash Algorithm	20110708
10	MS_STRUSTSMIM	Instance attribute	Private	☐	Type reference (TYPE)	STRUSTSMIM			20110801
11	MV_FORMAT	Instance attribute	Private	☐	Type reference (TYPE)	SSFFORM		SSF format	20110708
12	MV_LAST_VERIFY_CERT	Instance attribute	Private	☐	Type reference (TYPE)	XSTRING			20110708
13	MV_LOGICAL_NAME	Instance attribute	Private	☐	Type reference (TYPE)	SMIMELOGICALNAME		Logical name for a S/MIME identity	20120806
14	MV_PROFILE	Instance attribute	Protected	☐	Type reference (TYPE)	SSFPROF		SSF profile name	20110801
15	MV_TOOLKIT	Instance attribute	Private	☐	Type reference (TYPE)	SSFTOOLKIT		SSF: Selection of security product	20110708

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CREATE_INSTANCE	Static method	Public	Method	Returns a S/MIME instance	20110708
2	DECRYPT	Instance method	Public	Method	Decrypts the given data	20110708
3	ENCRYPT	Instance method	Public	Method	Encrypts the given data	20110708
4	GET_CRYPT_ALG	Instance method	Private	Method	Determine encryption algorithm	20110802
5	GET_PSE_TEXT	Instance method	Private	Method	Build PSE Name	20110927
6	GET_SIGN_ALG	Instance method	Private	Method	Determine signature hash algorithm	20110802
7	INIT	Instance method	Protected	Method	Initializes the S/MIME instance	20110708
8	PARSE_EMAIL_FROM_CERTIFICATE	Instance method	Private	Method	Parse email address from certificate	20110708
9	READ_LAST_ERROR	Instance method	Private	Method	Read information of the last error	20110708
10	READ_PROFILE	Instance method	Private	Method	Read profile	20110802
11	SIGN	Instance method	Public	Method	Signs the given data	20110708
12	VERIFY	Instance method	Public	Method	Verifies the given data	20110708

Events

Class CL_SMIME has no event.

Types

Class CL_SMIME has no local type.

Method Signatures

Method CREATE_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_NAME	Call by reference	☐	Type reference (TYPE)	SMIMELOGICALNAME		Logical name for a S/MIME identity	20110708
2	Returning	RO_SMIME	Value transfer	☐	Object reference (TYPE REF TO)	CL_SMIME		S/MIME - API	20110708

#	Exception	Resumable	Description	Created on
1	CX_SMIME_CRYPTO	☐	S/MIME exception	20110927

Method DECRYPT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_CRYPT_ALG	Call by reference	☐	Type reference (TYPE)	SSFENCR		SSF Encryption Algrorithm	20110708
2	Exporting	EV_DATA	Call by reference	☐	Type reference (TYPE)	XSTRING			20110708
3	Exporting	EV_KEY_LEN	Call by reference	☐	Type reference (TYPE)	SSFKEYLEN		SSF Key Length	20110708
4	Importing	IV_ENCRYPTED_DATA	Call by reference	☐	Type reference (TYPE)	XSTRING			20110708

#	Exception	Resumable	Description	Created on
1	CX_SMIME	☐	S/MIME exception	20110708
2	CX_SMIME_CRYPTO	☐	S/MIME exception	20110708

Method ENCRYPT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_ENCRYPTED_DATA	Call by reference	☐	Type reference (TYPE)	XSTRING			20110708
2	Importing	IT_TARGET	Call by reference	☐	Type reference (TYPE)	SMIMENAMECERT_T		Table of X.509 Certificates	20110708
3	Importing	IV_DATA	Call by reference	☐	Type reference (TYPE)	XSTRING			20110708

#	Exception	Resumable	Description	Created on
1	CX_SMIME	☐		20110708
2	CX_SMIME_CRYPTO	☐	S/MIME exception	20110708

Method GET_CRYPT_ALG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_TARGET	Call by reference	☐	Type reference (TYPE)	SMIMENAMECERT_T		S/MIME Name to Certificate Mapping	20110802
2	Returning	RV_ALGORITHM	Value transfer	☐	Type reference (TYPE)	SSFENCR		SSF Encryption Algrorithm	20110802

#	Exception	Resumable	Description	Created on
1	CX_SMIME	☐	S/MIME exception	20110802

Method GET_PSE_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_PSE_TEXT	Value transfer	☐	Type reference (TYPE)	STRING			20110927

Method GET_PSE_TEXT on class CL_SMIME has no exception.

Method GET_SIGN_ALG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_TARGET	Call by reference	☐	Type reference (TYPE)	SMIMELOGICALNAME_T		S/MIME logical name table	20110802
2	Returning	RV_ALGORITHM	Value transfer	☐	Type reference (TYPE)	SSFHASH		SSF Hash Algorithm	20110802

#	Exception	Resumable	Description	Created on
1	CX_SMIME	☐	S/MIME exception	20110802

Method INIT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_NAME	Call by reference	☐	Type reference (TYPE)	SMIMELOGICALNAME		Logical name for a S/MIME identity	20110708

#	Exception	Resumable	Description	Created on
1	CX_SMIME_CRYPTO	☐	S/MIME cryptographic exception	20110927

Method PARSE_EMAIL_FROM_CERTIFICATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CERTIFICATE	Call by reference	☐	Type reference (TYPE)	XSTRING			20110708
2	Returning	RV_EMAIL	Value transfer	☐	Type reference (TYPE)	STRING			20110708

#	Exception	Resumable	Description	Created on
1	CX_SMIME	☐	S/MIME exception	20110708

Method READ_LAST_ERROR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CRC	Call by reference	☐	Type reference (TYPE)	SSFRETURN		SSF Return code	20110708
2	Returning	RV_LAST_ERROR	Value transfer	☐	Type reference (TYPE)	STRING			20110708

Method READ_LAST_ERROR on class CL_SMIME has no exception.

Method READ_PROFILE Signature

Method READ_PROFILE on class CL_SMIME has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_SMIME	☐	S/MIME exception	20110802
2	CX_SMIME_CRYPTO	☐	S/MIME cryptographic exception	20120806

Method SIGN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_ALGORITHM	Call by reference	☐	Type reference (TYPE)	SSFHASH			20110708
2	Exporting	EV_SIGNATURE	Call by reference	☐	Type reference (TYPE)	XSTRING			20110708
3	Importing	IT_TARGET	Call by reference	☐	Type reference (TYPE)	SMIMELOGICALNAME_T		S/MIME logical name table	20110708
4	Importing	IV_DATA	Call by reference	☐	Type reference (TYPE)	XSTRING			20110708
5	Importing	IV_DETACHED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20110708

#	Exception	Resumable	Description	Created on
1	CX_SMIME	☐	S/MIME exception	20110708
2	CX_SMIME_CRYPTO	☐	S/MIME exception	20110708

Method VERIFY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_DATA	Call by reference	☐	Type reference (TYPE)	XSTRING			20110708
2	Exporting	EV_HASH_ALG	Call by reference	☐	Type reference (TYPE)	SSFHASH		SSF Hash Algorithm	20110708
3	Importing	IS_SOURCE	Call by reference	☐	Type reference (TYPE)	SMIMENAMECERT		S/MIME Name to Certificate Mapping	20110708
4	Importing	IV_DETACHED_DATA	Call by reference	☑	Type reference (TYPE)	XSTRING			20110708
5	Importing	IV_SIGNATURE	Call by reference	☐	Type reference (TYPE)	XSTRING			20110708

#	Exception	Resumable	Description	Created on
1	CX_SMIME	☐	S/MIME exception	20110708
2	CX_SMIME_CRYPTO	☐	S/MIME exception	20110708

History

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