rmi/luks.h

   1 /*
   2  *  Copyright (c) 2017 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  *  Licensed under the Apache License, Version 2.0 (the "License");
   5  *  you may not use this file except in compliance with the License.
   6  *  You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  *  Unless required by applicable law or agreed to in writing, software
  11  *  distributed under the License is distributed on an "AS IS" BASIS,
  12  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  *  See the License for the specific language governing permissions and
  14  *  limitations under the License
  15  */
  16
  17 #ifndef __ODE_LUKS_H__
  18 #define __ODE_LUKS_H__
  19
  20 #include <string>
  21
  22 namespace ode {
  23
  24 /**
  25  * This class provides APIs to perform luks operations.
  26  */
  27
  28 class Luks {
  29 public:
  30         virtual ~Luks() {};
  31
  32         virtual int format(bool sync,
  33                                            const std::string& device,
  34                                            const std::string& password) = 0;
  35
  36         virtual int open(bool sync,
  37                                          const std::string& device,
  38                                          const std::string& password,
  39                                          const std::string& mapping) = 0;
  40
  41         virtual int close(bool sync, const std::string& mapping) = 0;
  42
  43         enum Operation {
  44                 Format = 1,
  45                 Open   = 2,
  46                 Close  = 3
  47         };
  48
  49         static constexpr char* const NOTIFICATION = "LUKS_NOTIFICATION";
  50 };
  51
  52 } // namespace ode
  53
  54 #endif // __ODE_LUKS_H__