Skip to main content

C/C++ API Reference

Native reference for the Tricryption Engine C/C++ SDK, generated from the 8.1 engine source. The complete public class graph is cross-linked below; use the sidebar to browse, or search.

C API​

NameDescription
C APIThe teagent_c.h header file contains the ERUCES Agent C API function definitions.

C++ API​

The C++ classes and structs of the client library, expanded below and fully cross-linked.

Classes​

NameDescription
TEACLEntryThe TEACLEntry class manages access control list (ACL) entries.
TEACLInfoThe TEACLInfo class manages an ACL entry for each TTag.
TEACLTemplateThe TEACLTemplate class represents an access control list (ACL) template.
TEACLTemplateMemberThe TEACLTemplateMember class is used for the management of access control list (ACL)template members.
TEAdminThe TEAdmin class represents a Key Service administrator.
TEAdminACLThe TEAdminACL class administrates access control list (ACL) Templates.
TEAdminCertificateThe TEAdminCertificate class represents certificate administrative tasks and is derived from the TEAdmin class.
TEAdminCodeSigningThe TEAdminCodeSigning class is for code signing administration.
TEAdminConfigThe TEAdminConfig class administrates kS configuration.
TEAdminExceptionThe TEAdminException class represents a Key Service administrative exception.
TEAdminLocalThe TEAdminLocal class represents Remote Engine administrative tasks and is derived from the TEAdmin class.
TEAdminLogThe TEAdminLog class administrates event logging.
TEAdminQueryThe TEAdminQuery class is for query administration.
TEAdminTrustedServerThe TEAdminTrustedServer class represents Trusted Server administrative tasks and is derived from the TEAdmin class.
TEAgentThe TEAgent class represents the Key Service Agent and forms the base class of the TEAgentMatrix and TEAgentFile classes.
TEAgentExceptionThe TEAgentException class is the error handling class for TEAgent functions.
TEAgentFileThe TEAgentFile class encrypts and decrypts file data.
TEAgentFileEventThe TEAgentFileEvent class is used for file process events.
TEAgentMatrixThe TEAgentMatrix class represents a 2-D data matrix.
TEAuthenticationContextThe TEAuthenticationContext class is an abstract class representing the authentication context in use.
TECertAndPKeyThe TECertAndPKey class is used for TLS mutual authentication.
TECertObjectInfoThe TECertObjectInfo class provides methods for maintaining certificate objects.
TECipherThe TECipher class is an abstract interface for cryptographic operations.
TECipherStreamThe TECipherStream class is an abstract interface for cryptographic stream operations.
TECodeSigningInfoThe TECodeSigningInfo class is used to manage CodeSigning objects.
TEConnectionThe TEConnection class represents connections to the Key Service.
TEConnectionPoolThe TEConnectionPool class is for.
TEConnectionObjectThe TEConnectionObject class is for.
TECookieAuthenticationContextThe TECookieAuthenticationContext class is used to manage Token authentication.
TEDelegatedAuthenticationContextThe TEDelegatedAuthenticationContext class authenticates a delegated (impersonated) session through the Key Service's DelegatedAuthentication module (AM04).
TEEventLogThe TEEventLog class is for the management of event logs.
TEExceptionThe TEException class represents a Key Service exception.
TEGroupInfoThe TEGroupInfo class represents a group.
TEGssapiAuthenticationContextThe TEGssapiAuthenticationContext class authenticates the caller's Kerberos credentials to the Key Service through GSS-API, BOUND to the TLS connection the exchange runs over.
TEKeyThe TEKey class provides operations for creating, exporting and importing keys.
TEKeyCertUtilTEKeyCertUtil is an helper class which is used for certificate user connection to the Key Service.
TELDAPPrincipalInfoThe TELDAPPrincipalInfo class represents a user authenticated by LDAP-based authentication protocols.
TELdapAuthenticationContextThe TELdapAuthenticationContext class is used for the management of LDAP users.
TEMessagePrincipalThe TEMessagePrincipal class provides methods for maintaining message principals.
TEObjectThe TEObject class represents an object and forms the base class of the TEObjectTemplate classes.
TEObjectContainerThe TEObjectContainer class defines a container for objects and provides methods for managing those objects.
TEObjectTemplateThe TEObjectTemplate class is a template class used to define primitive TE objects; this class is derived from the TEObject class.
TEOperationThe TEOperation class represents an operation and is derived from the TEUpdatableObject class.
TEParameterThe TEParameter class represents the Key Service parameter.
TEParameterREThe TEParameterRE class represents the Remote Engine parameter class.
TEPrincipalInfoThe TEPrincipalInfo class is the principal base class and is derived from the TEUpdatableObject class.
TEPrincipalTrustMatrixThe TEPrincipalTrustMatrix class represents a principal trust matrix element.
TEQueryThe TEQuery class is a query class.
TERevocationEvidenceOne accepted CRL as the key server stores it (TE81-447, W35 round 2, ADR 0114).
TERevocationLookupThe key server's answer for one certificate (LOOKUP_REVOCATION).
TESSLMutualAuthenticationContextThe TESSLMutualAuthenticationContext class is for the management of TLS mutual authentication connections and PKCS 11,12 authentication.
TETemplatedDirectoryThe TETemplatedDirectory class represents a templated directory.
TETransportPrincipalInfoThe TETransportPrincipalInfo class provides methods for maintaining transportation principal information.
TETrustedServerInfoThe TETrustedServerInfo class provides methods for maintaining Trusted Server information.
TEUpdatableObjectThe TEUpdatableObject class is the base class for all objects which can be marshalled.
TEUserAgentThe TEUserAgent class is the Key Service administration class.
TEUserAndPasswordInfoThe TEUserAndPasswordInfo class represents a native user authenticated by a username and password pair.
TEUserAuthenticationContextThe TEUserAuthenticationContext class is used to manage Native users.
TEUserRoleThe TEUserRole class represents a user role and is derived from the TEUpdatableObject class.
TEX509AuthenticationContextThe TEX509AuthenticationContext class manages X.509 digital certificates.
TEXAuthPrincipalInfoThe TEXAuthPrincipalInfo class represents an Externally Authenticated (XAuth) principal: one authenticated by a system outside the Key Service and mapped into it as a DELEGATION TARGET.

Structs​

NameDescription
TE_CSTRING_BUFFERA caller-owned byte buffer described by its length AND its capacity.
TE_KEY_BUFFERA container for one exported key and the TTag that identifies it.
TE_STRU_BUFFERA container for a block of data and the two lengths that describe it.