Storage Engine API
mongo::EncryptionHooks Class Reference

#include <encryption_hooks.h>

Public Member Functions

virtual ~EncryptionHooks ()
 
virtual bool enabled () const
 Returns true if the encryption hooks are enabled. More...
 
virtual bool restartRequired ()
 Perform any encryption engine initialization/sanity checking that needs to happen after storage engine initialization but before the server starts accepting incoming connections. More...
 
size_t additionalBytesForProtectedBuffer ()
 Returns the maximum size addition when doing transforming temp data. More...
 
virtual std::unique_ptr< DataProtectorgetDataProtector ()
 Get the data protector object. More...
 
virtual boost::filesystem::path getProtectedPathSuffix ()
 Get an implementation specific path suffix to tag files with. More...
 
virtual Status protectTmpData (const uint8_t *in, size_t inLen, uint8_t *out, size_t outLen, size_t *resultLen)
 Transform temp data to non-readable form before writing it to disk. More...
 
virtual Status unprotectTmpData (const uint8_t *in, size_t inLen, uint8_t *out, size_t outLen, size_t *resultLen)
 Tranforms temp data back to readable form, after reading from disk. More...
 

Static Public Member Functions

static void set (ServiceContext *service, std::unique_ptr< EncryptionHooks > custHooks)
 
static EncryptionHooksget (ServiceContext *service)
 

Constructor & Destructor Documentation

◆ ~EncryptionHooks()

mongo::EncryptionHooks::~EncryptionHooks ( )
virtual

Member Function Documentation

◆ additionalBytesForProtectedBuffer()

size_t mongo::EncryptionHooks::additionalBytesForProtectedBuffer ( )
inline

Returns the maximum size addition when doing transforming temp data.

◆ enabled()

bool mongo::EncryptionHooks::enabled ( ) const
virtual

Returns true if the encryption hooks are enabled.

◆ get()

EncryptionHooks * mongo::EncryptionHooks::get ( ServiceContext *  service)
static

◆ getDataProtector()

std::unique_ptr< DataProtector > mongo::EncryptionHooks::getDataProtector ( )
virtual

Get the data protector object.

◆ getProtectedPathSuffix()

boost::filesystem::path mongo::EncryptionHooks::getProtectedPathSuffix ( )
virtual

Get an implementation specific path suffix to tag files with.

◆ protectTmpData()

Status mongo::EncryptionHooks::protectTmpData ( const uint8_t *  in,
size_t  inLen,
uint8_t *  out,
size_t  outLen,
size_t *  resultLen 
)
virtual

Transform temp data to non-readable form before writing it to disk.

◆ restartRequired()

bool mongo::EncryptionHooks::restartRequired ( )
virtual

Perform any encryption engine initialization/sanity checking that needs to happen after storage engine initialization but before the server starts accepting incoming connections.

Returns true if the server needs to be rebooted because of configuration changes.

◆ set()

void mongo::EncryptionHooks::set ( ServiceContext *  service,
std::unique_ptr< EncryptionHooks custHooks 
)
static

◆ unprotectTmpData()

Status mongo::EncryptionHooks::unprotectTmpData ( const uint8_t *  in,
size_t  inLen,
uint8_t *  out,
size_t  outLen,
size_t *  resultLen 
)
virtual

Tranforms temp data back to readable form, after reading from disk.


The documentation for this class was generated from the following files: