Application
Interfaces, Classes and Traits
- BatchEncryptedDocuments
- A batch of documents which have been encrypted.
- BatchPlaintextDocuments
- A batch of documents which have been decrypted.
- Bytes
- Wrapper around a string that contains raw bytes
- AesConstants
- CryptoRng
- Cryptographically-secure random number generator
- Rng
- DocumentParts
- A parsed IronCore encrypted document
- EncryptedDocument
- A set of fields which has been encrypted.
- EventMetadata
- RequestMetadata with an optional `timestampMillis` referencing when a security event took place.
- CryptoException
- This exception indicates a problem with encrypting, decrypting or verifying signatures.
- KmsException
- This exception indicates a problem with the Tenant Security Proxy talking to the KMS, or a problem with KMS keys.
- SecurityEventException
- This indicates a problem with logging a security event to the TSP.
- TenantSecurityException
- This exception indicates a problem talking to the TSP or the TSP talking to the key management servers. See the fromResponse static function for the code -> exception mapping.
- TspServiceException
- This indicates a problem from the Tenant Security Proxy itself (such as invalid API key).
- IclFields
- Holds metadata to pass to the Tenant Security Proxy for logging purposes.
- IclFieldsWithEvent
- Holds the event to pass to the Tenant Security Proxy for logging purposes.
- PlaintextDocument
- A decrypted document.
- DataControlPlatformHeader
- Generated from protobuf message <code>proto.ironcorelabs.cmk.DataControlPlatformHeader</code>
- SaaSShieldHeader
- Generated from protobuf message <code>proto.ironcorelabs.cmk.SaaSShieldHeader</code>
- V3DocumentHeader
- Generated from protobuf message <code>proto.ironcorelabs.cmk.V3DocumentHeader</code>
- RequestMetadata
- Holds metadata fields as part of an encrypted document. Each document has metadata associated with it that will be sent to the Tenant Security Proxy for logging and other purposes. Some examples include the tenant ID associated with the request, the service that is accessing the data, and a unique ID for the request.
- BatchUnwrapKeyRequest
- Request to the Tenant Security Proxy's batch unwrap keys endpoint
- BatchUnwrapKeyResponse
- Response from the Tenant Security Proxy's batch unwrap key endpoint
- BatchWrapKeyRequest
- Request to the Tenant Security Proxy's batch wrap keys endpoint
- BatchWrapKeyResponse
- Response from the Tenant Security Proxy's batch wrap key endpoint
- IronCoreRequest
- Abstract class representing a Tenant Security Proxy request object.
- LogSecurityEventRequest
- Request to the Tenant Security Proxy's security event logging endpoint
- RekeyRequest
- Request to the Tenant Security Proxy's re-key endpoint
- RekeyResponse
- Response from the Tenant Security Proxy's re-key endpoint
- UnwrapKeyRequest
- Request to the Tenant Security Proxy's unwrap key endpoint
- UnwrapKeyResponse
- Response from the Tenant Security Proxy's unwrap key endpoint
- WrapKeyRequest
- Request to the Tenant Security Proxy's wrap key endpoint
- WrapKeyResponse
- Response from the Tenant Security Proxy's wrap key endpoint
- AdminEvent
- CustomEvent
- DataEvent
- PeriodicEvent
- SecurityEvent
- UserEvent
- TenantSecurityClient
- Client used to encrypt and decrypt documents. This is the primary class that consumers of the library will need to utilize, and a single instance of the class can be re-used for requests across different tenants.
- TenantSecurityRequest
- Class used to communicate with the Tenant Security Proxy.
- V3HeaderSignature
- V3 IronCore header signature
- Aes
- Cryptographic functions. Not intended to be used by consumers of the SDK.
Table of Contents
- trimSlashes() : string
- Trims forward slashes (`/`) from the front and end of a string.
Functions
trimSlashes()
Trims forward slashes (`/`) from the front and end of a string.
trimSlashes(string $string) : string
Parameters
- $string : string
-
String to trim
Return values
string —Trimmed string