Microsoft Information Protection (MIP) SDK for C++: Reference 1.15
Doxygen-generated documentation for MIP SDK written in C++
Loading...
Searching...
No Matches
parsed_publishing_license.h
Go to the documentation of this file.
1/*
2 *
3 * Copyright (c) Microsoft Corporation.
4 * All rights reserved.
5 *
6 * This code is licensed under the MIT License.
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files(the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions :
14 *
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 * THE SOFTWARE.
25 *
26 */
27/**
28 * @brief Contains details of a parsed publishing license
29 *
30 * @file parsed_publishing_license.h
31 */
32
33#ifndef API_MIP_PROTECTION_PARSED_PUBLISHING_LICENSE_H_
34#define API_MIP_PROTECTION_PARSED_PUBLISHING_LICENSE_H_
35
36#include <chrono>
37#include <string>
38#include <vector>
39#include "mip/mip_namespace.h"
44
45MIP_NAMESPACE_BEGIN
46
48public:
49
50 /**
51 * @brief Gets the license domains
52 */
53 virtual const std::vector<std::string>& GetDomains() = 0;
54
55 /**
56 * @brief Gets the server public cert
57 */
58 virtual const std::string& GetServerPublicCert() = 0;
59
60 /**
61 * @brief Gets the content id
62 */
63 virtual const std::string& GetContentId() = 0;
64
65 /**
66 * @brief Gets the issuer id
67 */
68 virtual const std::string& GetIssuerId() = 0;
69
70 /**
71 * @brief Gets the double key algorithm
72 */
73 virtual const std::string& GetDoubleKeyAlgorithm() = 0;
74
75 /**
76 * @brief Gets the owner
77 */
78 virtual const std::string& GetOwner() = 0;
79
80 /**
81 * @brief Gets the connection info
82 */
83 virtual std::shared_ptr<LicenseConnectionInfo> GetConnectionInfo() = 0;
84
85 /**
86 * @brief Gets the descriptor
87 */
88 virtual std::shared_ptr<LicenseDescriptor> GetDescriptor() = 0;
89
90 /**
91 * @brief Gets the referral info url
92 */
93 virtual const std::string& GetReferralInfoUrl() = 0;
94
95 /**
96 * @brief Gets the signed application data
97 */
98 virtual const std::vector<std::shared_ptr<LicenseApplicationData>>& GetSignedApplicationData() = 0;
99
100 /**
101 * @brief Gets the issued time
102 */
103 virtual const std::chrono::time_point<std::chrono::system_clock>& GetIssuedTime() = 0;
104
105 /**
106 * @brief Gets the label info of the license, if applicable
107 */
108 virtual const mip::LabelInfo& GetLabelInfo() = 0;
109
110 /**
111 * @brief Gets the encrypted rights data. Used internally by the SDK. Applications should not try to decipher or modify this data.
112 */
113 virtual const std::vector<uint8_t>& GetEncryptedRightsData() = 0;
114
115 /** @cond DOXYGEN_HIDE */
116 virtual ~ParsedPublishingLicense() { }
117protected:
119 /** @endcond */
120};
121
122MIP_NAMESPACE_END
123
124#endif // API_MIP_PROTECTION_PARSED_PUBLISHING_LICENSE_H_
virtual const std::string & GetReferralInfoUrl()=0
Gets the referral info url.
virtual const std::string & GetContentId()=0
Gets the content id.
virtual const std::chrono::time_point< std::chrono::system_clock > & GetIssuedTime()=0
Gets the issued time.
virtual const mip::LabelInfo & GetLabelInfo()=0
Gets the label info of the license, if applicable.
virtual std::shared_ptr< LicenseDescriptor > GetDescriptor()=0
Gets the descriptor.
virtual const std::vector< std::string > & GetDomains()=0
Gets the license domains.
virtual const std::string & GetServerPublicCert()=0
Gets the server public cert.
virtual const std::string & GetDoubleKeyAlgorithm()=0
Gets the double key algorithm.
virtual const std::vector< std::shared_ptr< LicenseApplicationData > > & GetSignedApplicationData()=0
Gets the signed application data.
virtual const std::vector< uint8_t > & GetEncryptedRightsData()=0
Gets the encrypted rights data.
virtual std::shared_ptr< LicenseConnectionInfo > GetConnectionInfo()=0
Gets the connection info.
virtual const std::string & GetOwner()=0
Gets the owner.
virtual const std::string & GetIssuerId()=0
Gets the issuer id.
Defines LicenseApplicationData interface.
Defines LicenseConnectionInfo interface.
Defines LicenseDescriptor interface.
MIP namespace macros.
Defines ProtectionDescriptor interface.