| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=11"/> |
| <meta name="generator" content="Doxygen 1.9.8"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>iceberg-cpp: iceberg/catalog/rest/auth/auth_properties.h Source File</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr id="projectrow"> |
| <td id="projectalign"> |
| <div id="projectname">iceberg-cpp |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.9.8 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| var searchBox = new SearchBox("searchBox", "search/",'.html'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */ |
| </script> |
| <div id="main-nav"></div> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(document).ready(function() { init_codefold(0); }); |
| /* @license-end */ |
| </script> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <div id="MSearchResults"> |
| <div class="SRPage"> |
| <div id="SRIndex"> |
| <div id="SRResults"></div> |
| <div class="SRStatus" id="Loading">Loading...</div> |
| <div class="SRStatus" id="Searching">Searching...</div> |
| <div class="SRStatus" id="NoMatches">No Matches</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="dir_51d145386ec5f52aa06ebf5e46944abc.html">iceberg</a></li><li class="navelem"><a class="el" href="dir_a7beda0dac529a54d3cdf90e787bdce7.html">catalog</a></li><li class="navelem"><a class="el" href="dir_08d6efe6feae927f0fa1ad794a1878b0.html">rest</a></li><li class="navelem"><a class="el" href="dir_2148276f9150a57285320fbe9f3c6738.html">auth</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"><div class="title">auth_properties.h</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="auth__properties_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div> |
| <div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div> |
| <div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div> |
| <div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * distributed with this work for additional information</span></div> |
| <div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div> |
| <div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div> |
| <div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * "License"); you may not use this file except in compliance</span></div> |
| <div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> * with the License. You may obtain a copy of the License at</span></div> |
| <div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div> |
| <div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div> |
| <div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * software distributed under the License is distributed on an</span></div> |
| <div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div> |
| <div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * KIND, either express or implied. See the License for the</span></div> |
| <div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * specific language governing permissions and limitations</span></div> |
| <div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> * under the License.</span></div> |
| <div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"> */</span></div> |
| <div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div> |
| <div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#pragma once</span></div> |
| <div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div> |
| <div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#include <cstdint></span></div> |
| <div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include <optional></span></div> |
| <div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include <string></span></div> |
| <div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include <unordered_map></span></div> |
| <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div> |
| <div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#include "<a class="code" href="iceberg__rest__export_8h.html">iceberg/catalog/rest/iceberg_rest_export.h</a>"</span></div> |
| <div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#include "<a class="code" href="result_8h.html">iceberg/result.h</a>"</span></div> |
| <div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#include "<a class="code" href="config_8h.html">iceberg/util/config.h</a>"</span></div> |
| <div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div> |
| <div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div> |
| <div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceiceberg_1_1rest_1_1auth.html">iceberg::rest::auth</a> {</div> |
| <div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div> |
| <div class="foldopen" id="foldopen00037" data-start="{" data-end="};"> |
| <div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="classiceberg_1_1rest_1_1auth_1_1AuthProperties.html"> 37</a></span><span class="keyword">class </span>ICEBERG_REST_EXPORT <a class="code hl_class" href="classiceberg_1_1rest_1_1auth_1_1AuthProperties.html">AuthProperties</a> : <span class="keyword">public</span> <a class="code hl_class" href="classiceberg_1_1ConfigBase.html">ConfigBase</a><AuthProperties> {</div> |
| <div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">template</span> <<span class="keyword">typename</span> T></div> |
| <div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">using </span>Entry = <span class="keyword">const</span> <a class="code hl_class" href="classiceberg_1_1ConfigBase_1_1Entry.html">ConfigBase<AuthProperties>::Entry</a><T>;</div> |
| <div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div> |
| <div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="comment">// ---- Authentication type constants (not Entry-based) ----</span></div> |
| <div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div> |
| <div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keyword">const</span> std::string kAuthType = <span class="stringliteral">"rest.auth.type"</span>;</div> |
| <div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keyword">const</span> std::string kAuthTypeNone = <span class="stringliteral">"none"</span>;</div> |
| <div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keyword">const</span> std::string kAuthTypeBasic = <span class="stringliteral">"basic"</span>;</div> |
| <div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keyword">const</span> std::string kAuthTypeOAuth2 = <span class="stringliteral">"oauth2"</span>;</div> |
| <div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keyword">const</span> std::string kAuthTypeSigV4 = <span class="stringliteral">"sigv4"</span>;</div> |
| <div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> </div> |
| <div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <span class="comment">// ---- Basic auth entries ----</span></div> |
| <div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div> |
| <div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keyword">const</span> std::string kBasicUsername = <span class="stringliteral">"rest.auth.basic.username"</span>;</div> |
| <div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keyword">const</span> std::string kBasicPassword = <span class="stringliteral">"rest.auth.basic.password"</span>;</div> |
| <div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> </div> |
| <div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="comment">// ---- SigV4 entries ----</span></div> |
| <div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div> |
| <div class="line"><a id="l00059" name="l00059"></a><span class="lineno"><a class="line" href="classiceberg_1_1rest_1_1auth_1_1AuthProperties.html#af282e247167638df4e1fe539842f6b84"> 59</a></span> <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keyword">const</span> std::string kSigV4Enabled = <span class="stringliteral">"rest.sigv4-enabled"</span>;</div> |
| <div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keyword">const</span> std::string kSigV4DelegateAuthType =</div> |
| <div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> <span class="stringliteral">"rest.auth.sigv4.delegate-auth-type"</span>;</div> |
| <div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> </div> |
| <div class="line"><a id="l00066" name="l00066"></a><span class="lineno"><a class="line" href="classiceberg_1_1rest_1_1auth_1_1AuthProperties.html#a1d5dcfc25e4a2325c43af407f83cbae3"> 66</a></span> <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keyword">const</span> std::string kSigV4SigningRegion = <span class="stringliteral">"rest.signing-region"</span>;</div> |
| <div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keyword">const</span> std::string kSigV4SigningName = <span class="stringliteral">"rest.signing-name"</span>;</div> |
| <div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keyword">const</span> std::string kSigV4SigningNameDefault = <span class="stringliteral">"execute-api"</span>;</div> |
| <div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keyword">const</span> std::string kSigV4AccessKeyId = <span class="stringliteral">"rest.access-key-id"</span>;</div> |
| <div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keyword">const</span> std::string kSigV4SecretAccessKey = <span class="stringliteral">"rest.secret-access-key"</span>;</div> |
| <div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keyword">const</span> std::string kSigV4SessionToken = <span class="stringliteral">"rest.session-token"</span>;</div> |
| <div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> </div> |
| <div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> <span class="comment">// ---- OAuth2 entries ----</span></div> |
| <div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> </div> |
| <div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="keyword">inline</span> <span class="keyword">static</span> Entry<std::string> kToken{<span class="stringliteral">"token"</span>, <span class="stringliteral">""</span>};</div> |
| <div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> <span class="keyword">inline</span> <span class="keyword">static</span> Entry<std::string> kCredential{<span class="stringliteral">"credential"</span>, <span class="stringliteral">""</span>};</div> |
| <div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> <span class="keyword">inline</span> <span class="keyword">static</span> Entry<std::string> kScope{<span class="stringliteral">"scope"</span>, <span class="stringliteral">"catalog"</span>};</div> |
| <div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> <span class="keyword">inline</span> <span class="keyword">static</span> Entry<std::string> kOAuth2ServerUri{<span class="stringliteral">"oauth2-server-uri"</span>,</div> |
| <div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> <span class="stringliteral">"v1/oauth/tokens"</span>};</div> |
| <div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> <span class="keyword">inline</span> <span class="keyword">static</span> Entry<bool> kKeepRefreshed{<span class="stringliteral">"token-refresh-enabled"</span>, <span class="keyword">true</span>};</div> |
| <div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> <span class="keyword">inline</span> <span class="keyword">static</span> Entry<bool> kExchangeEnabled{<span class="stringliteral">"token-exchange-enabled"</span>, <span class="keyword">true</span>};</div> |
| <div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> <span class="keyword">inline</span> <span class="keyword">static</span> Entry<std::string> kAudience{<span class="stringliteral">"audience"</span>, <span class="stringliteral">""</span>};</div> |
| <div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> <span class="keyword">inline</span> <span class="keyword">static</span> Entry<std::string> kResource{<span class="stringliteral">"resource"</span>, <span class="stringliteral">""</span>};</div> |
| <div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> </div> |
| <div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> <span class="comment">// ---- OAuth2 token type constants ----</span></div> |
| <div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> </div> |
| <div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keyword">const</span> std::string kAccessTokenType =</div> |
| <div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> <span class="stringliteral">"urn:ietf:params:oauth:token-type:access_token"</span>;</div> |
| <div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keyword">const</span> std::string kRefreshTokenType =</div> |
| <div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> <span class="stringliteral">"urn:ietf:params:oauth:token-type:refresh_token"</span>;</div> |
| <div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keyword">const</span> std::string kIdTokenType =</div> |
| <div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> <span class="stringliteral">"urn:ietf:params:oauth:token-type:id_token"</span>;</div> |
| <div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keyword">const</span> std::string kSaml1TokenType =</div> |
| <div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> <span class="stringliteral">"urn:ietf:params:oauth:token-type:saml1"</span>;</div> |
| <div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keyword">const</span> std::string kSaml2TokenType =</div> |
| <div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> <span class="stringliteral">"urn:ietf:params:oauth:token-type:saml2"</span>;</div> |
| <div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keyword">const</span> std::string kJwtTokenType = <span class="stringliteral">"urn:ietf:params:oauth:token-type:jwt"</span>;</div> |
| <div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> </div> |
| <div class="line"><a id="l00100" name="l00100"></a><span class="lineno"><a class="line" href="classiceberg_1_1rest_1_1auth_1_1AuthProperties.html#ad2eca581ee6b6b6efc8b5abdbb4c5484"> 100</a></span> <span class="keyword">static</span> <a class="code hl_typedef" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result<AuthProperties></a> <a class="code hl_function" href="classiceberg_1_1rest_1_1auth_1_1AuthProperties.html#ad2eca581ee6b6b6efc8b5abdbb4c5484">FromProperties</a>(</div> |
| <div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> <span class="keyword">const</span> std::unordered_map<std::string, std::string>& properties);</div> |
| <div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> </div> |
| <div class="line"><a id="l00104" name="l00104"></a><span class="lineno"><a class="line" href="classiceberg_1_1rest_1_1auth_1_1AuthProperties.html#abf994144d9b4a7a4a90b724b77b6c26c"> 104</a></span> std::string <a class="code hl_function" href="classiceberg_1_1rest_1_1auth_1_1AuthProperties.html#abf994144d9b4a7a4a90b724b77b6c26c">token</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> Get(kToken); }</div> |
| <div class="line"><a id="l00106" name="l00106"></a><span class="lineno"><a class="line" href="classiceberg_1_1rest_1_1auth_1_1AuthProperties.html#a1ef10527c950afc8ea7d2890c5c3bcdf"> 106</a></span> std::string <a class="code hl_function" href="classiceberg_1_1rest_1_1auth_1_1AuthProperties.html#a1ef10527c950afc8ea7d2890c5c3bcdf">credential</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> Get(kCredential); }</div> |
| <div class="line"><a id="l00108" name="l00108"></a><span class="lineno"><a class="line" href="classiceberg_1_1rest_1_1auth_1_1AuthProperties.html#a9bf9004c9134712b456ec7188f65fd87"> 108</a></span> std::string <a class="code hl_function" href="classiceberg_1_1rest_1_1auth_1_1AuthProperties.html#a9bf9004c9134712b456ec7188f65fd87">scope</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> Get(kScope); }</div> |
| <div class="line"><a id="l00110" name="l00110"></a><span class="lineno"><a class="line" href="classiceberg_1_1rest_1_1auth_1_1AuthProperties.html#a2de70e190a117ccdd1a460abd4a1da27"> 110</a></span> std::string <a class="code hl_function" href="classiceberg_1_1rest_1_1auth_1_1AuthProperties.html#a2de70e190a117ccdd1a460abd4a1da27">oauth2_server_uri</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> Get(kOAuth2ServerUri); }</div> |
| <div class="line"><a id="l00112" name="l00112"></a><span class="lineno"><a class="line" href="classiceberg_1_1rest_1_1auth_1_1AuthProperties.html#ae5dcc0573e8885878a9ee885adee9871"> 112</a></span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classiceberg_1_1rest_1_1auth_1_1AuthProperties.html#ae5dcc0573e8885878a9ee885adee9871">keep_refreshed</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> Get(kKeepRefreshed); }</div> |
| <div class="line"><a id="l00114" name="l00114"></a><span class="lineno"><a class="line" href="classiceberg_1_1rest_1_1auth_1_1AuthProperties.html#a6b71a671c13d68aa09858989fa948490"> 114</a></span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classiceberg_1_1rest_1_1auth_1_1AuthProperties.html#a6b71a671c13d68aa09858989fa948490">exchange_enabled</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> Get(kExchangeEnabled); }</div> |
| <div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> </div> |
| <div class="line"><a id="l00117" name="l00117"></a><span class="lineno"><a class="line" href="classiceberg_1_1rest_1_1auth_1_1AuthProperties.html#acb9a674a365dad9149c9025982b3f61b"> 117</a></span> <span class="keyword">const</span> std::string& <a class="code hl_function" href="classiceberg_1_1rest_1_1auth_1_1AuthProperties.html#acb9a674a365dad9149c9025982b3f61b">client_id</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> client_id_; }</div> |
| <div class="line"><a id="l00119" name="l00119"></a><span class="lineno"><a class="line" href="classiceberg_1_1rest_1_1auth_1_1AuthProperties.html#a89ad096600233a1cce6cddd9e17a18e9"> 119</a></span> <span class="keyword">const</span> std::string& <a class="code hl_function" href="classiceberg_1_1rest_1_1auth_1_1AuthProperties.html#a89ad096600233a1cce6cddd9e17a18e9">client_secret</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> client_secret_; }</div> |
| <div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> </div> |
| <div class="line"><a id="l00122" name="l00122"></a><span class="lineno"><a class="line" href="classiceberg_1_1rest_1_1auth_1_1AuthProperties.html#a0196f616aa5a29422b52ac5d4a2266ce"> 122</a></span> std::unordered_map<std::string, std::string> <a class="code hl_function" href="classiceberg_1_1rest_1_1auth_1_1AuthProperties.html#a0196f616aa5a29422b52ac5d4a2266ce">optional_oauth_params</a>() <span class="keyword">const</span>;</div> |
| <div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> </div> |
| <div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> <span class="keyword">private</span>:</div> |
| <div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> std::string client_id_;</div> |
| <div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> std::string client_secret_;</div> |
| <div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> std::string token_type_;</div> |
| <div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> std::optional<int64_t> expires_at_millis_;</div> |
| <div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span>};</div> |
| </div> |
| <div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span> </div> |
| <div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span>} <span class="comment">// namespace iceberg::rest::auth</span></div> |
| <div class="ttc" id="aclassiceberg_1_1ConfigBase_1_1Entry_html"><div class="ttname"><a href="classiceberg_1_1ConfigBase_1_1Entry.html">iceberg::ConfigBase::Entry</a></div><div class="ttdef"><b>Definition</b> config.h:73</div></div> |
| <div class="ttc" id="aclassiceberg_1_1ConfigBase_html"><div class="ttname"><a href="classiceberg_1_1ConfigBase.html">iceberg::ConfigBase</a></div><div class="ttdef"><b>Definition</b> config.h:70</div></div> |
| <div class="ttc" id="aclassiceberg_1_1rest_1_1auth_1_1AuthProperties_html"><div class="ttname"><a href="classiceberg_1_1rest_1_1auth_1_1AuthProperties.html">iceberg::rest::auth::AuthProperties</a></div><div class="ttdoc">Authentication properties.</div><div class="ttdef"><b>Definition</b> auth_properties.h:37</div></div> |
| <div class="ttc" id="aclassiceberg_1_1rest_1_1auth_1_1AuthProperties_html_a0196f616aa5a29422b52ac5d4a2266ce"><div class="ttname"><a href="classiceberg_1_1rest_1_1auth_1_1AuthProperties.html#a0196f616aa5a29422b52ac5d4a2266ce">iceberg::rest::auth::AuthProperties::optional_oauth_params</a></div><div class="ttdeci">std::unordered_map< std::string, std::string > optional_oauth_params() const</div><div class="ttdoc">Build optional OAuth params (audience, resource) from config.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1rest_1_1auth_1_1AuthProperties_html_a1ef10527c950afc8ea7d2890c5c3bcdf"><div class="ttname"><a href="classiceberg_1_1rest_1_1auth_1_1AuthProperties.html#a1ef10527c950afc8ea7d2890c5c3bcdf">iceberg::rest::auth::AuthProperties::credential</a></div><div class="ttdeci">std::string credential() const</div><div class="ttdoc">Get the raw credential string.</div><div class="ttdef"><b>Definition</b> auth_properties.h:106</div></div> |
| <div class="ttc" id="aclassiceberg_1_1rest_1_1auth_1_1AuthProperties_html_a2de70e190a117ccdd1a460abd4a1da27"><div class="ttname"><a href="classiceberg_1_1rest_1_1auth_1_1AuthProperties.html#a2de70e190a117ccdd1a460abd4a1da27">iceberg::rest::auth::AuthProperties::oauth2_server_uri</a></div><div class="ttdeci">std::string oauth2_server_uri() const</div><div class="ttdoc">Get the token endpoint URI.</div><div class="ttdef"><b>Definition</b> auth_properties.h:110</div></div> |
| <div class="ttc" id="aclassiceberg_1_1rest_1_1auth_1_1AuthProperties_html_a6b71a671c13d68aa09858989fa948490"><div class="ttname"><a href="classiceberg_1_1rest_1_1auth_1_1AuthProperties.html#a6b71a671c13d68aa09858989fa948490">iceberg::rest::auth::AuthProperties::exchange_enabled</a></div><div class="ttdeci">bool exchange_enabled() const</div><div class="ttdoc">Whether token exchange is enabled.</div><div class="ttdef"><b>Definition</b> auth_properties.h:114</div></div> |
| <div class="ttc" id="aclassiceberg_1_1rest_1_1auth_1_1AuthProperties_html_a89ad096600233a1cce6cddd9e17a18e9"><div class="ttname"><a href="classiceberg_1_1rest_1_1auth_1_1AuthProperties.html#a89ad096600233a1cce6cddd9e17a18e9">iceberg::rest::auth::AuthProperties::client_secret</a></div><div class="ttdeci">const std::string & client_secret() const</div><div class="ttdoc">Parsed client_secret from credential.</div><div class="ttdef"><b>Definition</b> auth_properties.h:119</div></div> |
| <div class="ttc" id="aclassiceberg_1_1rest_1_1auth_1_1AuthProperties_html_a9bf9004c9134712b456ec7188f65fd87"><div class="ttname"><a href="classiceberg_1_1rest_1_1auth_1_1AuthProperties.html#a9bf9004c9134712b456ec7188f65fd87">iceberg::rest::auth::AuthProperties::scope</a></div><div class="ttdeci">std::string scope() const</div><div class="ttdoc">Get the OAuth2 scope.</div><div class="ttdef"><b>Definition</b> auth_properties.h:108</div></div> |
| <div class="ttc" id="aclassiceberg_1_1rest_1_1auth_1_1AuthProperties_html_abf994144d9b4a7a4a90b724b77b6c26c"><div class="ttname"><a href="classiceberg_1_1rest_1_1auth_1_1AuthProperties.html#abf994144d9b4a7a4a90b724b77b6c26c">iceberg::rest::auth::AuthProperties::token</a></div><div class="ttdeci">std::string token() const</div><div class="ttdoc">Get the bearer token.</div><div class="ttdef"><b>Definition</b> auth_properties.h:104</div></div> |
| <div class="ttc" id="aclassiceberg_1_1rest_1_1auth_1_1AuthProperties_html_acb9a674a365dad9149c9025982b3f61b"><div class="ttname"><a href="classiceberg_1_1rest_1_1auth_1_1AuthProperties.html#acb9a674a365dad9149c9025982b3f61b">iceberg::rest::auth::AuthProperties::client_id</a></div><div class="ttdeci">const std::string & client_id() const</div><div class="ttdoc">Parsed client_id from credential (empty if no colon).</div><div class="ttdef"><b>Definition</b> auth_properties.h:117</div></div> |
| <div class="ttc" id="aclassiceberg_1_1rest_1_1auth_1_1AuthProperties_html_ad2eca581ee6b6b6efc8b5abdbb4c5484"><div class="ttname"><a href="classiceberg_1_1rest_1_1auth_1_1AuthProperties.html#ad2eca581ee6b6b6efc8b5abdbb4c5484">iceberg::rest::auth::AuthProperties::FromProperties</a></div><div class="ttdeci">static Result< AuthProperties > FromProperties(const std::unordered_map< std::string, std::string > &properties)</div><div class="ttdoc">Build an AuthProperties from a properties map.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1rest_1_1auth_1_1AuthProperties_html_ae5dcc0573e8885878a9ee885adee9871"><div class="ttname"><a href="classiceberg_1_1rest_1_1auth_1_1AuthProperties.html#ae5dcc0573e8885878a9ee885adee9871">iceberg::rest::auth::AuthProperties::keep_refreshed</a></div><div class="ttdeci">bool keep_refreshed() const</div><div class="ttdoc">Whether token refresh is enabled.</div><div class="ttdef"><b>Definition</b> auth_properties.h:112</div></div> |
| <div class="ttc" id="aconfig_8h_html"><div class="ttname"><a href="config_8h.html">config.h</a></div><div class="ttdoc">Provide typed configuration helpers.</div></div> |
| <div class="ttc" id="aiceberg__rest__export_8h_html"><div class="ttname"><a href="iceberg__rest__export_8h.html">iceberg_rest_export.h</a></div><div class="ttdoc">Define symbol visibility macros for the REST catalog library.</div></div> |
| <div class="ttc" id="anamespaceiceberg_1_1rest_1_1auth_html"><div class="ttname"><a href="namespaceiceberg_1_1rest_1_1auth.html">iceberg::rest::auth</a></div><div class="ttdoc">REST catalog authentication APIs.</div><div class="ttdef"><b>Definition</b> auth_manager.h:34</div></div> |
| <div class="ttc" id="anamespaceiceberg_html_a9d5594e371beb516b0120e07e69d3af6"><div class="ttname"><a href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">iceberg::Result</a></div><div class="ttdeci">std::expected< T, E > Result</div><div class="ttdoc">Result alias.</div><div class="ttdef"><b>Definition</b> result.h:88</div></div> |
| <div class="ttc" id="aresult_8h_html"><div class="ttname"><a href="result_8h.html">result.h</a></div><div class="ttdoc">Define Result, Status, and error helpers.</div></div> |
| </div><!-- fragment --></div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 |
| </small></address> |
| </body> |
| </html> |
