SAP ABAP Class CL_SMIME_EMAIL (S/MIME Adapter for email)

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_EMAIL
Short Description	S/MIME Adapter for email
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	20100705	SAP
Last change	20140121	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)
2	IF_BADI_SMIME_EMAIL	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

Class CL_SMIME_EMAIL has no interface implemented.

Friends

Class CL_SMIME_EMAIL has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_RC_CERTIFICATE_AMBIGIOUS	Constant	Public	☐	Type reference (TYPE)	SMIMERCEMAIL	5	S/MIME return code for email	20121128
2	CO_RC_CERTIFICATE_INVALID	Constant	Public	☐	Type reference (TYPE)	SMIMERCEMAIL	2	S/MIME return code for email	20121128
3	CO_RC_CERTIFICATE_KEYUSAGE	Constant	Public	☐	Type reference (TYPE)	SMIMERCEMAIL	3	S/MIME return code for email	20121128
4	CO_RC_CERTIFICATE_NOT_FOUND	Constant	Public	☐	Type reference (TYPE)	SMIMERCEMAIL	1	S/MIME return code for email	20121128
5	CO_RC_CERTIFICATE_REVOKED	Constant	Public	☐	Type reference (TYPE)	SMIMERCEMAIL	4	S/MIME return code for email	20121128
6	CO_RC_OK	Constant	Public	☐	Type reference (TYPE)	SMIMERCEMAIL	0	S/MIME return code for email	20121128
7	CO_RC_PSE_NOT_FOUND	Constant	Public	☐	Type reference (TYPE)	SMIMERCEMAIL	6	S/MIME return code for email	20121128
8	MO_BADI_PROXY	Static Attribute	Private	☐	Object reference (TYPE REF TO)	IF_BADI_SMIME_EMAIL		Interface for BAdI: SMIME_EMAIL	20130205
9	MO_SMIME	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_SMIME		S/MIME - API	20110708

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20130205
2	CREATE_INSTANCE	Static method	Public	Method	Returns a S/MIME email instance	20110708
3	DECRYPT	Instance method	Public	Method	Decrypt the given data	20110708
4	ENCRYPT	Instance method	Public	Method	Encrypt the given data	20110708
5	GET_CERTIFICATE_BY_EMAIL	Static method	Private	Method	Get certificate for the given email address	20130205
6	IS_ENCRYPTION_POSSIBLE	Static method	Public	Method	Check whether email encryption is possible	20121128
7	IS_SIGNATURE_POSSIBLE	Static method	Public	Method	Check whether email signing is possible	20121128
8	SET_BADI_PROXY	Static method	Private	Method	Set BAdI proxy instance for testing	20130205
9	SIGN	Instance method	Public	Method	Sign the given data	20110708
10	VERIFY	Instance method	Public	Method	Verify the given data	20110708

Events

Class CL_SMIME_EMAIL has no event.

Types

Class CL_SMIME_EMAIL has no local type.

Method Signatures

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_SMIME_EMAIL has no parameter.
Method CLASS_CONSTRUCTOR on class CL_SMIME_EMAIL has no exception.

Method CREATE_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_EMAIL	Call by reference	☐	Type reference (TYPE)	STRING			20110708
2	Returning	RO_SMIME_EMAIL	Value transfer	☐	Object reference (TYPE REF TO)	CL_SMIME_EMAIL		S/MIME Adapter for email	20110708

#	Exception	Resumable	Description	Created on
1	CX_SMIME_CRYPTO	☐	S/MIME cryptographic 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			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			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_TO	Call by reference	☐	Type reference (TYPE)	STRING_TABLE		Table of Strings	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_CERTIFICATE_BY_EMAIL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IF_EMAIL	Call by reference	☐	Type reference (TYPE)	STRING			20130205
2	Importing	IF_KEYUSAGE	Call by reference	☐	Type reference (TYPE)	IF_BADI_SMIME_EMAIL=>TY_KEYUSAGE		Key usage	20130205
3	Returning	RO_CERTIFICATE	Value transfer	☐	Object reference (TYPE REF TO)	CL_ABAP_X509_CERTIFICATE		Return elements of an X.509 Certificate	20130205

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

Method IS_ENCRYPTION_POSSIBLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_RECEIVER_EMAIL	Call by reference	☐	Type reference (TYPE)	STRING		Table of Strings	20121128
2	Returning	RV_RC	Value transfer	☐	Type reference (TYPE)	SMIMERCEMAIL		S/MIME return code for email	20121128

Method IS_ENCRYPTION_POSSIBLE on class CL_SMIME_EMAIL has no exception.

Method IS_SIGNATURE_POSSIBLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SENDER_EMAIL	Call by reference	☐	Type reference (TYPE)	STRING			20121128
2	Returning	RV_RC	Value transfer	☐	Type reference (TYPE)	SMIMERCEMAIL		Natural number	20121128

Method IS_SIGNATURE_POSSIBLE on class CL_SMIME_EMAIL has no exception.

Method SET_BADI_PROXY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_BADI_PROXY	Call by reference	☐	Object reference (TYPE REF TO)	IF_BADI_SMIME_EMAIL		Interface for BAdI: SMIME_EMAIL	20130205

Method SET_BADI_PROXY on class CL_SMIME_EMAIL has no exception.

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_TO	Call by reference	☐	Type reference (TYPE)	STRING_TABLE		Table of Strings	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	☐		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			20110708
3	Importing	IV_DETACHED_DATA	Call by reference	☑	Type reference (TYPE)	XSTRING			20110708
4	Importing	IV_FROM	Call by reference	☐	Type reference (TYPE)	STRING			20110708
5	Importing	IV_SIGNATURE	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

History

Last changed by/on	SAP	20140121
SAP Release Created in