rmi/external-encryption.h

   1 /*
   2  *  Copyright (c) 2015 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 __EXTERNAL_ENCRYPTION_H__
  18 #define __EXTERNAL_ENCRYPTION_H__
  19
  20 #include <string>
  21
  22 namespace ode {
  23
  24 /**
  25  * This class provides APIs to manage the encryption of external stroage
  26  * such as SD card.
  27  */
  28
  29 class ExternalEncryption {
  30 public:
  31         virtual ~ExternalEncryption() {};
  32
  33         virtual int setMountPassword(const std::string& password) = 0;
  34
  35         virtual int mount() = 0;
  36         virtual int umount() = 0;
  37
  38         virtual int encrypt(const std::string& password, unsigned int options) = 0;
  39         virtual int decrypt(const std::string& password) = 0;
  40
  41         virtual int recovery() = 0;
  42
  43         virtual int isPasswordInitialized() = 0;
  44         virtual int initPassword(const std::string& password) = 0;
  45         virtual int cleanPassword(const std::string& password) = 0;
  46         virtual int changePassword(const std::string& oldPW, const std::string& newPW) = 0;
  47         virtual int verifyPassword(const std::string& password) = 0;
  48
  49         enum State {
  50                 NotSupported = -1,
  51                 Unencrypted  = 0,
  52                 Encrypted    = 1,
  53                 Corrupted    = 2,
  54         };
  55
  56         virtual int getState() = 0;
  57
  58         enum Option {
  59                 OnlyNewFile = 1 << 0,
  60                 ExceptForMediaFile = 1 << 1,
  61         };
  62
  63         virtual unsigned int getSupportedOptions() = 0;
  64
  65         virtual std::string getDevicePath() const = 0;
  66 };
  67
  68 } // namespace ode
  69
  70 #endif // __EXTERNAL_ENCRYPTION_H__