SAP ABAP Class CL_SAML20_OAUTH_ASSERTION (Class for processing of OAuth 2 assertions)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-SEC (Application Component) Security
⤷
SOAUTH2 (Package) OAuth2
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-SEC (Application Component) Security⤷
SOAUTH2 (Package) OAuth2Meta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Inheritance (c INHERITING FROM c_ref) | CL_SAML20_BEARER_ASSERTION | Common class for SAML 2.0 bearer assertions | 20120308 |
Properties
| Class | CL_SAML20_OAUTH_ASSERTION | |
| Short Description | Class for processing of OAuth 2 assertions | |
| Super Class | CL_SAML20_BEARER_ASSERTION | Common class for SAML 2.0 bearer assertions |
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | P | SAP Standard Production Program |
| Category | 0 | |
| Package | SOAUTH2 | OAuth2 |
| Created | 20111216 | 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_SAML20_OAUTH_ASSERTION has no interface implemented.
Friends
Class CL_SAML20_OAUTH_ASSERTION has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | MV_TOK_EP_IN_AUDIENCE_VALID |
Instance attribute | Private | Type reference (TYPE) | BOOLEAN | Boolean Variable (X=True, -=False, Space=Unknown) | 20120823 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CHECK_NOT_ON_OR_AFTER |
Instance method | Private | Method | Checks the timestamp against specified NotOnOrAfter | 20120307 |
| 2 | CONSTRUCTOR |
Instance method | Public | Constructor | CONSTRUCTOR | 20120127 |
| 3 | GET_ASSERTION_LOG_DATA |
Instance method | Public | Method | 20120522 | |
| 4 | TRACE_RETURN_DATA |
Instance method | Private | Method | Traces the data to be returned | 20120127 |
| 5 | VALIDATE_SAML20_ASSERTION |
Static method | Public | Method | Parses, validates and extracts the user data for assertion | 20120127 |
Events
Class CL_SAML20_OAUTH_ASSERTION has no event.
Types
Class CL_SAML20_OAUTH_ASSERTION has no local type.
Method Signatures
Method CHECK_NOT_ON_OR_AFTER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IV_NOT_ON_OR_AFTER | Call by reference | Type reference (TYPE) | SAML2_DATETIME | SAML2 (xs:dateTime) | 20120307 | ||
| 2 |  Returning |
RV_VALID | Value transfer | Type reference (TYPE) | ABAP_BOOL | True if NotOnOrAfter is valid | 20120307 |
Method CHECK_NOT_ON_OR_AFTER on class CL_SAML20_OAUTH_ASSERTION has no exception.
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IT_CONF_EXPECTED_ATTRIBUTES | Call by reference | Type reference (TYPE) | SAML2_STRING_T | SAML 2.0 URI Table | 20120127 | ||
| 2 | Importing |
IT_CONF_SUPPORTED_AUTHN_CTX | Call by reference | Type reference (TYPE) | SAML2_AUTH_CLASS_KEY_T | Auth. CXT Class Key Table Type | 20120127 | ||
| 3 | Importing |
IT_CONF_SUPPORTED_NAMEID_FMT | Call by reference | Type reference (TYPE) | SAML2_STRING_T | SAML2 String Table | 20120127 | ||
| 4 | Importing |
IV_CLIENT | Call by reference | Type reference (TYPE) | MANDT | Client test for translation (to be deleted!) | 20120127 | ||
| 5 | Importing |
IV_CONF_CLOCK_SKEW | Call by reference | Type reference (TYPE) | I | 20120127 | |||
| 6 | Importing |
IV_CONF_DECR_SSF_APPLICATION | Call by reference | Type reference (TYPE) | SSFAPPL | 20120127 | |||
| 7 | Importing |
IV_CONF_LOCAL_ENTITY_NAME | Call by reference | Type reference (TYPE) | SAML2_ENTITY_NAME | SAML2 Entity ID | 20120127 | ||
| 8 | Importing |
IV_CONF_MAX_TOKEN_VALIDITY | Call by reference | Type reference (TYPE) | I | 20120127 | |||
| 9 | Importing |
IV_CONF_RECIPIENT | Call by reference | Type reference (TYPE) | STRING | 20120127 | |||
| 10 | Importing |
IV_DECRYPTION_SSF_APPLICATION | Call by reference | Type reference (TYPE) | SSFAPPL | SSF application for decryption | 20120306 | ||
| 11 | Importing |
IV_SEC_SIGN_VALIDATION_CERT | Call by reference | Type reference (TYPE) | XSTRING | X509 secondary signing certificate for signature validation | 20120306 | ||
| 12 | Importing |
IV_SIGNATURE_SSF_APPLICATION | Call by reference | Type reference (TYPE) | SSFAPPL | SSF application for signature validation | 20120306 | ||
| 13 | Importing |
IV_SIGNATURE_VALIDATION_CERT | Call by reference | Type reference (TYPE) | XSTRING | X509 certificate for signature validation | 20120306 |
Method CONSTRUCTOR on class CL_SAML20_OAUTH_ASSERTION has no exception.
Method GET_ASSERTION_LOG_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
ES_ASSERTION | Call by reference | Type reference (TYPE) | SAML2_ASSERTION | Structure of an SAML 2.0 Assertion | 20120522 | ||
| 2 | Exporting |
ES_SUBJECT_NAMEID | Call by reference | Type reference (TYPE) | SAML2_NAME_ID | Structure for SAML 2.0 Type: NameIDType | 20120522 | ||
| 3 | Exporting |
ET_ATTRIBUTES | Call by reference | Type reference (TYPE) | SAML2_ASSERTION_ATTRIBUTES_T | Table of SAML2 attribute couples | 20120522 |
Method GET_ASSERTION_LOG_DATA on class CL_SAML20_OAUTH_ASSERTION has no exception.
Method TRACE_RETURN_DATA Signature
Method TRACE_RETURN_DATA on class CL_SAML20_OAUTH_ASSERTION has no parameter.
Method TRACE_RETURN_DATA on class CL_SAML20_OAUTH_ASSERTION has no exception.
Method VALIDATE_SAML20_ASSERTION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ES_NAME_ID | Call by reference | Type reference (TYPE) | SAML2_NAME_ID | SAML 2.0 NameID structure | 20120127 | ||
| 2 | Exporting |
ET_ATTRIBUTES | Call by reference | Type reference (TYPE) | SAML2_ASSERTION_ATTRIBUTES_T | SAML 2.0 attributes found in the assertion | 20120127 | ||
| 3 | Importing |
IT_CRYPTO_ASSERT_SUBELEMENTS | Call by reference | Type reference (TYPE) | SAML_ELEMENT_T | Assertion subelements that must be encrypted or signed | 20120127 | ||
| 4 | Importing |
IT_EXPECTED_ATTRIBUTES | Call by reference | Type reference (TYPE) | SAML2_STRING_T | Expected SAML 2.0 attributes in the assertion | 20120127 | ||
| 5 | Importing |
IT_SUPPORTED_AUTHN_CONTEXTS | Call by reference | Type reference (TYPE) | SAML2_AUTH_CLASS_KEY_T | Supported authentication contexts | 20120127 | ||
| 6 | Importing |
IT_SUPPORTED_HASH_ALGORITHMS | Call by reference | Type reference (TYPE) | SAML2_HASH_ALGORITHM_T | Supported hash algorithms for signature verification | 20120127 | ||
| 7 | Importing |
IT_SUPPORTED_NAME_ID_FORMATS | Call by reference | Type reference (TYPE) | SAML2_ANYURI_T | Supported NameID formats | 20120127 | ||
| 8 | Importing |
IV_CLIENT | Call by reference | Type reference (TYPE) | MANDT | ABAP client for tracing purposes | 20120127 | ||
| 9 | Importing |
IV_CLOCK_SKEW | Call by reference | Type reference (TYPE) | I | 360 | Clock skew tolerance between systems (in second) | 20120127 | |
| 10 | Importing |
IV_DECRYPTION_SSF_APPLICATION | Call by reference | Type reference (TYPE) | SSFAPPL | SSF application for decryption | 20120127 | ||
| 11 | Importing |
IV_ISSUER | Call by reference | Type reference (TYPE) | STRING | SAML 2.0 message issuer | 20120127 | ||
| 12 | Importing |
IV_LOCAL_ENTITY_NAME | Call by reference | Type reference (TYPE) | SAML2_ENTITY_NAME | Local entity name | 20120127 | ||
| 13 | Importing |
IV_MAX_TOKEN_VALIDITY | Call by reference | Type reference (TYPE) | I | Further restrictions for validity period window | 20120127 | ||
| 14 | Importing |
IV_MUST_BE_ENCRYPTED | Call by reference | Type reference (TYPE) | SAML2_BOOLEAN | ABAP_FALSE | Assertion must be encrypted | 20120127 | |
| 15 | Importing |
IV_MUST_BE_SIGNED | Call by reference | Type reference (TYPE) | SAML2_BOOLEAN | ABAP_TRUE | Assertion must be signed | 20120127 | |
| 16 | Importing |
IV_RECIPIENT | Call by reference | Type reference (TYPE) | STRING | Expected recipient URL | 20120127 | ||
| 17 | Importing |
IV_SEC_SIGN_VALIDATION_CERT | Call by reference | Type reference (TYPE) | XSTRING | X509 secondary signing certificate for signature validation | 20120127 | ||
| 18 | Importing |
IV_SIGNATURE_SSF_APPLICATION | Call by reference | Type reference (TYPE) | SSFAPPL | SSF application for signature validation | 20120127 | ||
| 19 | Importing |
IV_SIGNATURE_VALIDATION_CERT | Call by reference | Type reference (TYPE) | XSTRING | X509 certificate for signature validation | 20120127 | ||
| 20 | Importing |
IV_XML | Call by reference | Type reference (TYPE) | XSTRING | The assertion to parse and validate | 20120127 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_SAML20_CORE |
Raises an exception if an error occurs during the processing | 20120127 |
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 732 |
