xref: /onnv-gate/usr/src/lib/libkmsagent/common/ClientSoapFaultCodes.h (revision 12720:3db6e0082404)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 
22 /*
23  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24  */
25 
26 #ifndef CLIENTSOAPFAULTCODES_H
27 #define CLIENTSOAPFAULTCODES_H
28 
29 /**
30  * Enumeration of error codes that have corresponding soap error strings.
31  * Note: These start at 1000 to avoid overlapping with other soap error codes
32  *
33  * The format of these enumerations is roughly as follows:
34  *
35  * Start with CLIENT_ERROR_
36  *
37  * Next, put AGENT if the error is intended for the KMA Agent interface
38  *       put MANAGER if the error is intended for the KMS Manager interface
39  *       put SERVER if the error is the fault of the KMS server for any interface
40  *
41  * After that, briefly describe the error.
42  */
43 enum SoapClientErrorCode
44 {
45     INVALID_CLIENT_ERROR = 0,
46     CLIENT_ERROR_ACCESS_DENIED = 1000,
47     CLIENT_ERROR_SERVER_BUSY,
48     CLIENT_ERROR_AUTHENTICATION_FAILED,
49     CLIENT_ERROR_NETWORK_ADDRESS_UNREACHABLE,
50     CLIENT_ERROR_INVALID_EXPECTED_PEER_LAST_KNOWN_TIMESTAMP_VECTOR,
51     CLIENT_ERROR_INCOMPATIBLE_VERSION,
52     CLIENT_ERROR_INCOMPATIBLE,
53     CLIENT_ERROR_BUNDLE_ALREADY_IN_PROGRESS,
54     CLIENT_ERROR_AGENT_INVALID_PARAMETERS,
55     CLIENT_ERROR_AGENT_KEY_DOES_NOT_EXIST,
56     CLIENT_ERROR_AGENT_KEY_DESTROYED,
57     CLIENT_ERROR_AGENT_DATA_UNIT_ID_NOT_FOUND_EXTERNAL_ID_EXISTS,
58     CLIENT_ERROR_AGENT_DATA_UNIT_EXPIRED,
59     CLIENT_ERROR_INVALID_DATA_UNIT_ID,
60     CLIENT_ERROR_INVALID_KEY_ID,
61     CLIENT_ERROR_AGENT_DUPLICATE_EXTERNAL_ID,
62     CLIENT_ERROR_AGENT_INVALID_EXTERNAL_ID,
63     CLIENT_ERROR_AGENT_DATA_UNIT_NOT_REKEYABLE,
64     CLIENT_ERROR_AGENT_APPLIANCE_LOCKED,
65     CLIENT_ERROR_AGENT_INVALID_PASSPHRASE,
66     CLIENT_ERROR_DATA_UNIT_NOT_FOUND,
67     CLIENT_ERROR_AGENT_NO_READY_KEYS,
68     CLIENT_ERROR_MANAGER_INVALID_PARAMETERS,
69     CLIENT_ERROR_MANAGER_DATA_UNIT_NOT_DESTROYED,
70     CLIENT_ERROR_MANAGER_APPLIANCE_EXISTS,
71     CLIENT_ERROR_MANAGER_APPLIANCE_DOES_NOT_EXIST,
72     CLIENT_ERROR_MANAGER_CANNOT_DELETE_LOCAL_APPLIANCE,
73     CLIENT_ERROR_MANAGER_APPLIANCE_IN_USE,
74     CLIENT_ERROR_MANAGER_AGENT_EXISTS,
75     CLIENT_ERROR_MANAGER_AGENT_DOES_NOT_EXIST,
76     CLIENT_ERROR_MANAGER_AGENT_IN_USE,
77     CLIENT_ERROR_MANAGER_USER_EXISTS,
78     CLIENT_ERROR_MANAGER_USER_DOES_NOT_EXIST,
79     CLIENT_ERROR_MANAGER_USER_IN_USE,
80     CLIENT_ERROR_MANAGER_ROLE_DOES_NOT_EXIST,
81     CLIENT_ERROR_MANAGER_USER_ROLE_EXISTS,
82     CLIENT_ERROR_MANAGER_USER_ROLE_DOES_NOT_EXIST,
83     CLIENT_ERROR_MANAGER_CANNOT_DELETE_ONLY_SECURITY_OFFICER,
84     CLIENT_ERROR_MANAGER_CANNOT_REMOVE_ONLY_SECURITY_OFFICER_ROLE,
85     CLIENT_ERROR_MANAGER_SITE_EXISTS,
86     CLIENT_ERROR_MANAGER_SITE_DOES_NOT_EXIST,
87     CLIENT_ERROR_MANAGER_SITE_IN_USE,
88     CLIENT_ERROR_MANAGER_CANNOT_SET_PASSPHRASE_FOR_LOCAL_APPLIANCE,
89     CLIENT_ERROR_MANAGER_INVALID_PASSPHRASE,
90     CLIENT_ERROR_MANAGER_LIFETIME_OVERRIDE_NOT_PERMITTED,
91     CLIENT_ERROR_MANAGER_AGENT_ALREADY_IN_KEY_GROUP,
92     CLIENT_ERROR_MANAGER_AGENT_ALREADY_HAS_DEFAULT_KEY_GROUP,
93     CLIENT_ERROR_MANAGER_AGENT_NOT_IN_KEY_GROUP,
94     CLIENT_ERROR_MANAGER_CORE_SECURITY_ALREADY_LOCKED,
95     CLIENT_ERROR_MANAGER_CORE_SECURITY_ALREADY_UNLOCKED,
96     CLIENT_ERROR_MANAGER_BACKUP_ID_DOES_NOT_EXIST,
97     CLIENT_ERROR_MANAGER_BACKUP_DOES_NOT_EXIST,
98     CLIENT_ERROR_MANAGER_BACKUP_RESTORE_DENIED,
99     CLIENT_ERROR_MANAGER_BACKUP_OR_RESTORE_IN_PROGRESS,
100     CLIENT_ERROR_MANAGER_BACKUP_RESTORE_FILE_DUPLICATE_ENTITY_FAILURE,
101     CLIENT_ERROR_MANAGER_BACKUP_RESTORE_FILE_INVALID,
102     CLIENT_ERROR_MANAGER_FILE_CHUNK_OFFSET_INVALID,
103     CLIENT_ERROR_MANAGER_FILE_CHUNK_IO_ERROR,
104     CLIENT_ERROR_MANAGER_BACKUP_ALREADY_DESTROYED,
105     CLIENT_ERROR_MANAGER_BACKUP_DESTROYED,
106     CLIENT_ERROR_MANAGER_BACKUP_NOT_AVAILABLE,
107     CLIENT_ERROR_MANAGER_CLOCK_ADJUSTMENT_LIMIT_EXCEEDED,
108     CLIENT_ERROR_MANAGER_CLOCK_ADJUSTMENT_ALREADY_PERFORMED_TODAY,
109     CLIENT_ERROR_MANAGER_CLOCK_ADJUSTMENT_FAILED,
110     CLIENT_ERROR_MANAGER_SOFTWARE_UPGRADE_FILE_NOT_FOUND,
111     CLIENT_ERROR_MANAGER_SOFTWARE_UPGRADE_FAILED,
112     CLIENT_ERROR_MANAGER_LIST_SOFTWARE_VERSIONS_FAILED,
113     CLIENT_ERROR_MANAGER_CHANGE_SOFTWARE_VERSION_FAILED,
114     CLIENT_ERROR_MANAGER_VERIFY_SOFTWARE_UPLOAD_FAILED,
115     CLIENT_ERROR_MANAGER_SNMP_MANAGER_EXISTS,
116     CLIENT_ERROR_MANAGER_SNMP_MANAGER_DOES_NOT_EXIST,
117     CLIENT_ERROR_MANAGER_TRANSFER_PARTNER_DOES_NOT_EXIST,
118     CLIENT_ERROR_MANAGER_TRANSFER_PARTNER_EXISTS,
119     CLIENT_ERROR_MANAGER_TRANSFER_PARTNER_IN_USE,
120     CLIENT_ERROR_MANAGER_TRANSFER_PARTNER_ALREADY_IN_KEY_GROUP,
121     CLIENT_ERROR_MANAGER_TRANSFER_PARTNER_NOT_IN_KEY_GROUP,
122     CLIENT_ERROR_MANAGER_TRANSFER_PARTNER_NOT_ENABLED,
123     CLIENT_ERROR_MANAGER_TRANSFER_PARTNER_NOT_ALLOWED_EXPORT_TO,
124     CLIENT_ERROR_MANAGER_TRANSFER_PARTNER_HAS_NO_PUBLIC_KEYS,
125     CLIENT_ERROR_MANAGER_TRANSFER_PARTNER_PUBLIC_KEY_ID_ALREADY_EXISTS,
126     CLIENT_ERROR_MANAGER_APPLIANCE_LOCKED,
127     CLIENT_ERROR_MANAGER_DATA_UNIT_EXPIRED,
128     CLIENT_ERROR_MANAGER_UNEXPECTED_TRANSFER_PARTNER,
129     CLIENT_ERROR_MANAGER_KEY_GROUP_DOES_NOT_ALLOW_EXPORT_FROM,
130     CLIENT_ERROR_MANAGER_TRANSFER_PARTNER_KEY_GROUP_ACCESS_DENIED,
131     CLIENT_ERROR_MANAGER_TRANSFER_PARTNER_NOT_ALLOWED_IMPORT_FROM,
132     CLIENT_ERROR_MANAGER_KEY_GROUP_NOT_ALLOWED_IMPORT_TO,
133     CLIENT_ERROR_MANAGER_DUPLICATE_DATA_UNIT_ID,
134     CLIENT_ERROR_MANAGER_DUPLICATE_DATA_UNIT_KEY_ID,
135     CLIENT_ERROR_MANAGER_DUPLICATE_EXTERNAL_ID,
136     CLIENT_ERROR_MANAGER_CORE_SECURITY_PUBLIC_KEY_NOT_FOUND,
137     CLIENT_ERROR_MANAGER_CHANGE_PRIMARY_LOCAL_NETWORK_ADDRESS_DENIED,
138     CLIENT_ERROR_MANAGER_CHANGE_SECONDARY_LOCAL_NETWORK_ADDRESS_DENIED,
139     CLIENT_ERROR_MANAGER_KEY_POLICY_EXISTS,
140     CLIENT_ERROR_MANAGER_KEY_POLICY_DOES_NOT_EXIST,
141     CLIENT_ERROR_MANAGER_KEY_POLICY_IN_USE,
142     CLIENT_ERROR_MANAGER_CHANGE_SOFTWARE_VERSION_IN_PROGRESS,
143     CLIENT_ERROR_MANAGER_VERIFY_SOFTWARE_UPLOAD_IN_PROGRESS,
144     CLIENT_ERROR_MANAGER_APPLY_SOFTWARE_VERSION_IN_PROGRESS,
145     CLIENT_ERROR_MANAGER_KEY_GROUP_EXISTS,
146     CLIENT_ERROR_MANAGER_KEY_GROUP_DOES_NOT_EXIST,
147     CLIENT_ERROR_MANAGER_KEY_GROUP_IN_USE,
148     CLIENT_ERROR_MANAGER_KEY_DOES_NOT_EXIST,
149     CLIENT_ERROR_MANAGER_KEY_ALREADY_COMPROMISED,
150     CLIENT_ERROR_MANAGER_KEY_ALREADY_IN_KEY_GROUP,
151     CLIENT_ERROR_MANAGER_INVALID_BACKUP_ID,
152     CLIENT_ERROR_MANAGER_LIMIT_EXCEEDED,
153     CLIENT_ERROR_MANAGER_SYSTEM_DUMP_FAILED,
154     CLIENT_ERROR_MANAGER_SYSTEM_DUMP_DOES_NOT_EXIST,
155     CLIENT_ERROR_MANAGER_ADD_NTP_SERVER_FAILED,
156     CLIENT_ERROR_MANAGER_DELETE_NTP_SERVER_FAILED,
157     CLIENT_ERROR_MANAGER_NTP_SERVER_SPECIFIED,
158     CLIENT_ERROR_MANAGER_GET_LOCAL_CLOCK_FAILED,
159     CLIENT_ERROR_MANAGER_ADJUST_LOCAL_CLOCK_FAILED,
160     CLIENT_ERROR_MANAGER_NEED_CORE_SECURITY_BACKUP,
161     CLIENT_ERROR_MANAGER_KEY_DESTRUCTION_IN_PROGRESS,
162     CLIENT_ERROR_IMPORT_10KEYS_ALREADY_UPLOADED,
163     CLIENT_ERROR_IMPORT_10KEYS_FILE_DOES_NOT_EXIST,
164     CLIENT_ERROR_IMPORT_10KEYS_INVALID_FILE_FORMAT,
165     CLIENT_ERROR_IMPORT_10KEYS_FILE_READ_ERROR,
166     CLIENT_ERROR_IMPORT_10KEYS_FAILED,
167     CLIENT_ERROR_IMPORT_10KEYS_DUPLICATE_KEY_ID_AND_VALUE,
168     CLIENT_ERROR_IMPORT_10KEYS_DUPLICATE_KEY_ID,
169     CLIENT_ERROR_IMPORT_10KEYS_KEY_VALUE_NOT_HEX,
170     CLIENT_ERROR_INVALID_BACKUP_TIME,
171     CLIENT_ERROR_KEY_TRANSFER_IN_PROGRESS,
172     CLIENT_ERROR_KEY_TRANSFER_FILE_NOT_VALIDATED,
173     CLIENT_ERROR_LOCAL_APPLIANCE_NOT_PEER_SERVER,
174     CLIENT_ERROR_CANNOT_CONTACT_PEER_SERVER,
175     CLIENT_ERROR_MISMATCHED_SIGNING_PUBLIC_KEY_ID,
176     CLIENT_ERROR_MISMATCHED_ENCRYPTION_PUBLIC_KEY_ID,
177     CLIENT_ERROR_DATA_UNIT_HAS_NO_EXPORTABLE_KEYS,
178     CLIENT_ERROR_SOME_KEYS_NOT_EXPORTABLE, // This is actually a warning -- should we treat it differently? Start at 2000?
179     CLIENT_ERROR_UPDATE_REPLICATION_SCHEMA,
180     CLIENT_ERROR_NOT_SUPPORTED,
181     CLIENT_ERROR_AGENT_KWK_NOT_REGISTERED,
182     CLIENT_ERROR_AGENT_KWK_ID_MISMATCH,
183     CLIENT_ERROR_LIST_KMA_NETWORK_ADDRESSES_FAILED,
184     CLIENT_ERROR_GET_KMA_DNS_INFORMATION_FAILED,
185     CLIENT_ERROR_LIST_KMA_ROUTING_TABLE_ENTRIES_FAILED,
186     CLIENT_ERROR_EXPORT_FORMAT_DISALLOWED,
187     CLIENT_ERROR_TRANSFER_FORMAT_DISALLOWED,
188     CLIENT_ERROR_FIPS_MODE_REQUIRED,
189     CLIENT_ERROR_CLIENT_UPGRADE_REQUIRED,
190     CLIENT_ERROR_RESTORE_INVALID_BACKUP_XML_FORMAT,
191     CLIENT_ERROR_MANAGER_INVALID_MASTER_KEY_PROVIDER_PARAMETERS,
192     CLIENT_ERROR_MANAGER_PENDED_OPERATION_ID_DOES_NOT_EXIST,
193     CLIENT_ERROR_INVALID_PENDED_OPERATION_TYPE,
194     CLIENT_ERROR_SERVER_HSM_REQUIRED_BUT_MISSING,
195     CLIENT_ERROR_MANAGER_INTERNAL,
196     CLIENT_ERROR_AGENT_INVALID_HMAC,
197     CLIENT_ERROR_AGENT_INVALID_KEY,
198     CLIENT_ERROR_QUORUM_NOT_MET,
199     CLIENT_ERROR_MANAGER_CANNOT_QUERY_NTP_SERVER,
200     CLIENT_ERROR_MANAGER_NTP_SERVER_DELTA_TOO_BIG,
201     CLIENT_ERROR_MANAGER_CANNOT_UPDATE_NTP_CONFIG,
202     CLIENT_ERROR_MANAGER_CANNOT_CONTACT_SNMP_MANAGER,
203     CLIENT_ERROR_MANAGER_CORE_SECURITY_ERROR_INTERNAL,
204     CLIENT_ERROR_MANAGER_CORE_SECURITY_NOT_FOUND,
205 
206     //  NOTE:  When you add a new CLIENT_ERROR_* definition above this comment,
207     //         you should also add:
208     //
209     //         1)  A case statement for it near the end of the switch
210     //             statement in the GetSoapClientErrorCodeMessage() routine
211     //             in the Common/SoapFaults/ClientSoapFaults.cpp file
212     //         2)  A case statement for it near the end of the switch
213     //             statement in the GetTranslatedSoapFault() routine in the
214     //             Common/SoapFaults/ClientSoapErrorTranslator.cpp file
215     //         3)  A case statement for it near the end of the switch statement
216     //             in the GetErrorString routine in the
217     //             Client/Manager/Global.cpp file
218 
219     CLIENT_ERROR_LAST
220 };
221 
222 
223 #define GET_FAULT_CODE(errstr) (atoi(errstr))
224 
225 #endif //CLIENTSOAPFAULTCODES_H
226