> For the complete documentation index, see [llms.txt](https://sandbox-docs.verifone.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://sandbox-docs.verifone.com/s-adk-5.1-programmers-guide/readme/annotated/class_s_d_i_plugin.md). # SDIPlugin [Public Types](#pub-types) | [Public Member Functions](#pub-methods) `#include <`[sdiplugin.h](/s-adk-5.1-programmers-guide/sdiplugin_8h_source.md)`>` | | | | ------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Public Types | | | enum |

SDITrigger {
SDITrigger\_None = 0, SDITrigger\_CardDetected = 1 << 0, SDITrigger\_EMVConfig = 1 << 1, SDITrigger\_SDIConfig = 1 << 2,
SDITrigger\_CardDataAvail = 1 << 3, SDITrigger\_MsgDataAvail = 1 << 4, SDITrigger\_EmvCndListCbk = 1 << 5, SDITrigger\_CardId = 1 << 6,
SDITrigger\_FactoryReset = 1 << 7, SDITrigger\_ExternalCSD = 1 << 8, SDITrigger\_ExtDataStore = 1 << 9, SDITrigger\_ManualPan = 1 << 10,
SDITrigger\_CTLSSmartISO = 1 << 11
}

| | enum | [SDIExtension](#ac54b73bc0f666acecb26aec563933dab) { [SDIExt\_TrustedConnection](#ac54b73bc0f666acecb26aec563933dabaf68f9bf3b8cf2c74c727593f815b2ad5) = 0, [SDIExt\_PCI\_Version](#ac54b73bc0f666acecb26aec563933daba06c111cc8a22f1561b77db6fc6ce4273) = 1, [SDIExt\_VCL\_Callback](#ac54b73bc0f666acecb26aec563933dabadfaf20e6f6b758be305a019675c7b015) = 4 } | | typedef std::vector< unsigned char > | [Buffer](#a8f502862992b828150656db48c9ce5fc) | | | | | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Public Member Functions | | | virtual | [\~SDIPlugin](#ac61cfcf3cd3dab4e87ac55016184d452) () | | virtual const char \* | [name](#a1a30ad8f276a2310571c36239554831a) () const =0 | | virtual void | [version](#a796f4754af60a767410df08daef5dc06) (int \&major, int \&minor, int \&patch) const =0 | | virtual int | [moduleID](#a8d2bc1f2997927e41cff153194099c40) () const =0 | | virtual unsigned | [supportedTriggers](#ae369ce7304446cc914cb2f62a3f22307) () const =0 | | virtual int | [processMessage](#a3c7b193aa5b72dc9e8a627619230cf2f) ([Buffer](#a8f502862992b828150656db48c9ce5fc) \&result, int cmd, const [Buffer](#a8f502862992b828150656db48c9ce5fc) \&message)=0 | | virtual int | [processTrigger](#a0f730d467656f854300839d8013f9205) ([Buffer](#a8f502862992b828150656db48c9ce5fc) \&result, unsigned triggerID, const [Buffer](#a8f502862992b828150656db48c9ce5fc) \&message)=0 | | virtual void \* | [openExtension](#aae0f81c75ffaeacd5af7bbe3b4b86062) (int ext\_number)=0 | | virtual void | [closeExtension](#a07bbd9c2e7fc03a0f408560bf09d7091) (void \*extension)=0 | ### DetailedDescription Abstract [SDIPlugin](/s-adk-5.1-programmers-guide/readme/annotated/class_s_d_i_plugin.md) base class ### MemberTypedef Documentation ### Buffer typedef std::vector\ \[Buffer]\(#a8f502862992b828150656db48c9ce5fc) buffer type ### MemberEnumeration Documentation ### SDIExtension enum \[SDIExtension]\(#ac54b73bc0f666acecb26aec563933dab) SDI plugin extensions | | | | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Enumerator | | | SDIExt\_TrustedConnection | Provide the information to the plugin if the SDI connection is trusted or not. This is actually used for trigger SDITrigger\_EMVConfig. The [openExtension()](#aae0f81c75ffaeacd5af7bbe3b4b86062) returns a pointer to bool in that case. !!! NOTE: SDIExt\_TrustedConnection is DEPRECATED and no longer invoked by SDI !!! | | SDIExt\_PCI\_Version | Obtain PCI version of the plugin (if available). [openExtension()](#aae0f81c75ffaeacd5af7bbe3b4b86062) call returns C-string (const char\*) containing PCI version string. If there is no PCI versioning for the plugin, NULL is returned. | | SDIExt\_VCL\_Callback | Provide a function pointer (of type Vcl\_Encryption\_Callback\_Setter) for VCL encryption by SDI. This is used for plugins that register for trigger SDITrigger\_ExtDataStore. [openExtension()](#aae0f81c75ffaeacd5af7bbe3b4b86062) call returns a function pointer for which SDI will set the callback function for VCL encryption. If this functionality is not supported by the plugin, NULL is returned. | ### SDITrigger enum \[SDITrigger]\(#a82c0da164c73dfba432f58136b1d3dab) SDI plugin trigger IDs in the form 1<\Cardholder Sensitive Data not available in the SDI Data Store, try to get them from the plugin Following tags are provided to the plugin:

F0/DF3B: Options, 4 bytes. Byte 4 bit 1: Clear text flag. Relevant only in case VTP is enabled If set to true and VTP is enabled, the plugin has to deliver clear text data (VTP decrypted) Per default, when VTP is enabled, the plugin has to deliver VTP encrypted data. Byte 4 bit 2: Request to clear sensitive data. Called by SDI Server on a Clear Data Store 29-03 command

F0/DF3C: Requested tags, array with 4 bytes for each tag

| | SDITrigger\_ManualPan | Provide entered PAN during manual card data entry for further processing, e.g whitelist check | | SDITrigger\_CTLSSmartISO | Redirect EMV\_CTLS\_SmartISO to the plugin instead of EMV ADK | ### Constructor& Destructor Documentation ### \~SDIPlugin() virtual \\\~[SDIPlugin](/s-adk-5.1-programmers-guide/readme/annotated/class_s_d_i_plugin.md) inlinevirtual Destructor ### MemberFunction Documentation ### closeExtension() virtual void closeExtension pure virtual close extension **Parameters** \[in] **extension** pointer as returned from openExtension ### moduleID() virtual int moduleID pure virtual obtain module ID that identifies the plugin (parameter p1 in the SDI interface) #### Returns module ID ### name() virtual const char\\\* name pure virtual #### Returns String containing the name of the plugin ### openExtension() virtual void\\\* openExtension pure virtual open extension. Extensions need to be closed using [closeExtension()](#a07bbd9c2e7fc03a0f408560bf09d7091) when no longer needed. **Parameters** \[in] **ext\_number** extension number #### Returns pointer to extension or NULL if the extension is not known ### processMessage() virtual int processMessage pure virtual process SDI message sent by application **Parameters** \[out] **result** buffer containing the result of the operation. The plugin shall write the SW1/SW2 bytes in the first two bytes of the buffer, followed by the data to be returned to the application. It's recommended to use BER-TLV format for encoding the returned data, and enclose the data in tag F0. If the plugin does not return the SW1/SW2 bytes then SDI will ignore the result buffer and return 6802 ("Invalid result returned from the plugin") to the application. \[in] **cmd** P1 parameter in the SDI interface that identifies the function \[in] **message** input message recommended is to use BER-TLV format for encoding the content of the buffer #### Returns result code, e.g. 0x9000 for OK ### processTrigger() virtual int processTrigger pure virtual process trigger ID invoked from SDI server **Parameters** \[out] **result** buffer containing the result of the operation, recommended is to use BER-TLV format for encoding the content of the buffer \[in] **triggerID** trigger ID \[in] **message** input input format depends on the triggerID. #### Returns result code, e.g. 0x9000 for OK ### supportedTriggers() virtual unsigned supportedTriggers pure virtual #### Returns trigger ID mask that are supported by this plugin. This is the or-ed value of all supported SDITriggers. ### version() virtual void version pure virtual obtain version information **Parameters** \[out] **major** major version \[out] **minor** minor version \[out] **patch** patch version *** The documentation for this class was generated from the following file: * sdi/src/[sdiplugin.h](/s-adk-5.1-programmers-guide/sdiplugin_8h_source.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://sandbox-docs.verifone.com/s-adk-5.1-programmers-guide/readme/annotated/class_s_d_i_plugin.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.