encryptor.h
Go to the documentation of this file.
1 /*********************************************************************
2 * Software License Agreement (BSD License)
3 *
4 * Copyright (c) 2017, Open Source Robotics Foundation
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 *
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above
14 * copyright notice, this list of conditions and the following
15 * disclaimer in the documentation and/or other materials provided
16 * with the distribution.
17 * * Neither the name of Willow Garage, Inc. nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32 * POSSIBILITY OF SUCH DAMAGE.
33 *********************************************************************/
34 
35 #ifndef ROSBAG_ENCRYPTION_H
36 #define ROSBAG_ENCRYPTION_H
37 
38 #include "rosbag/buffer.h"
39 #include "rosbag/chunked_file.h"
40 #include "rosbag/structures.h"
41 
42 #include "ros/header.h"
43 
44 #include <stdint.h>
45 #include <string>
46 
47 #include <boost/function.hpp>
48 
49 
50 namespace rosbag {
51 
52 class Bag;
53 
54 class EncryptorBase
55 {
56 protected:
57  EncryptorBase() { }
58 
59 public:
60  virtual ~EncryptorBase() { }
61 
63 
69  virtual void initialize(Bag const& bag, std::string const& plugin_param) = 0;
70 
72 
81  virtual uint32_t encryptChunk(const uint32_t chunk_size, const uint64_t chunk_data_pos, ChunkedFile& file) = 0;
82 
84 
91  virtual void decryptChunk(ChunkHeader const& chunk_header, Buffer& decrypted_chunk, ChunkedFile& file) const = 0;
92 
94 
100  virtual void addFieldsToFileHeader(ros::M_string& header_fields) const = 0;
101 
103 
108  virtual void readFieldsFromFileHeader(ros::M_string const& header_fields) = 0;
109 
111 
118  virtual void writeEncryptedHeader(boost::function<void(ros::M_string const&)> write_header, ros::M_string const& header_fields, ChunkedFile& file) = 0;
119 
121 
129  virtual bool readEncryptedHeader(boost::function<bool(ros::Header&)> read_header, ros::Header& header, Buffer& header_buffer, ChunkedFile& file) = 0;
130 };
131 
132 }
133 
134 #endif
rosbag::ChunkedFile
ChunkedFile reads and writes files which contain interleaved chunks of compressed and uncompressed da...
Definition: chunked_file.h:83
rosbag::EncryptorBase::EncryptorBase
EncryptorBase()
Definition: encryptor.h:89
rosbag::EncryptorBase::encryptChunk
virtual uint32_t encryptChunk(const uint32_t chunk_size, const uint64_t chunk_data_pos, ChunkedFile &file)=0
Encrypt chunk.
rosbag::EncryptorBase::decryptChunk
virtual void decryptChunk(ChunkHeader const &chunk_header, Buffer &decrypted_chunk, ChunkedFile &file) const =0
Decrypt chunk.
ros::Header
rosbag::EncryptorBase::readEncryptedHeader
virtual bool readEncryptedHeader(boost::function< bool(ros::Header &)> read_header, ros::Header &header, Buffer &header_buffer, ChunkedFile &file)=0
Read encrypted header from bag file.
rosbag::EncryptorBase::initialize
virtual void initialize(Bag const &bag, std::string const &plugin_param)=0
Initialize encryptor.
rosbag::Buffer
Definition: buffer.h:75
structures.h
buffer.h
rosbag::EncryptorBase::writeEncryptedHeader
virtual void writeEncryptedHeader(boost::function< void(ros::M_string const &)> write_header, ros::M_string const &header_fields, ChunkedFile &file)=0
Write encrypted header to bag file.
rosbag::EncryptorBase::addFieldsToFileHeader
virtual void addFieldsToFileHeader(ros::M_string &header_fields) const =0
Add encryptor information to bag file header.
rosbag::EncryptorBase::~EncryptorBase
virtual ~EncryptorBase()
Definition: encryptor.h:92
header.h
rosbag::EncryptorBase::readFieldsFromFileHeader
virtual void readFieldsFromFileHeader(ros::M_string const &header_fields)=0
Read encryptor information from bag file header.
rosbag
Definition: aes_encryptor.h:43
chunked_file.h
ros::M_string
std::map< std::string, std::string > M_string


rosbag_storage
Author(s): Dirk Thomas , Jacob Perron
autogenerated on Sat Sep 14 2024 02:59:52