RStudio Launcher Plugin SDK  1.1.3
A software development kit for creating plugins that work the the RStudio Launcher.
LocalSecureCookie.hpp
1 /*
2  * SecureCookie.hpp
3  *
4  * Copyright (C) 2020 by RStudio, PBC
5  *
6  * Unless you have received this program directly from RStudio pursuant to the terms of a commercial license agreement
7  * with RStudio, then this program is licensed to you under the following terms:
8  *
9  * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
10  * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
11  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
12  * permit persons to whom the Software is furnished to do so, subject to the following conditions:
13  *
14  * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
15  * Software.
16  *
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
18  * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
19  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
20  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21  *
22  */
23 
24 
25 #ifndef LAUNCHER_PLUGINS_LOCAL_SECURE_COOKIE_HPP
26 #define LAUNCHER_PLUGINS_LOCAL_SECURE_COOKIE_HPP
27 
28 #include <string>
29 
30 namespace rstudio {
31 namespace launcher_plugins {
32 
33 class Error;
34 
35 } // namespace launcher_plugins
36 } // namespace rstudio
37 
38 namespace rstudio {
39 namespace launcher_plugins {
40 namespace local {
41 
46 {
47 public:
51  LocalSecureCookie() = default;
52 
58  Error initialize();
59 
65  const std::string& getKey() const;
66 
67 private:
69  std::string m_key;
70 };
71 
72 } // namespace local
73 } // namespace launcher_plugins
74 } // namespace rstudio
75 
76 #endif
rstudio::launcher_plugins::local::LocalSecureCookie::getKey
const std::string & getKey() const
Gets the secure cookie key.
rstudio::launcher_plugins::local::LocalSecureCookie::initialize
Error initialize()
Reads and validates the secure-cookie-key from the location specified in the options.
rstudio::launcher_plugins::Error
Class which represents an error.
Definition: Error.hpp:174
rstudio::launcher_plugins::local::LocalSecureCookie
Reads and makes available the secure-cookie-key-file specified in the launcher.local....
Definition: LocalSecureCookie.hpp:45
rstudio::launcher_plugins::local::LocalSecureCookie::LocalSecureCookie
LocalSecureCookie()=default
Constructor.