OpenDNSSEC-enforcer  1.3.14
kmedef.h
Go to the documentation of this file.
1 /*
2  * $Id: kmedef.h 5267 2011-06-29 08:12:29Z sion $
3  *
4  * Copyright (c) 2008-2009 Nominet UK. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in the
13  * documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
19  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
21  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
23  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
24  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
25  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  *
27  */
28 
29 #ifndef KSM_KMEDEF_H
30 #define KSM_KMEDEF_H
31 
32 /*+
33  * kmedef.h - Define KSM Error Codes
34  *
35  * Description:
36  * Defines the various status codes that can be returned by the various
37  * KSM routines.
38  *
39  * All status codes - with the exception of KME_SUCCESS - are above
40  * 65,536. Below this, status values are assumed to be error values
41  * returned from the operating system.
42 -*/
43 
44 #define KME_SUCCESS 0 /* Successful completion */
45 
46 #define KME_BASE 65536 /* Base of KSM status codes */
47 
48 #define KME_ACTKEYRET (KME_BASE + 0) /* INFO: %d keys in 'active' state will have their expected retire date modified */
49 #define KME_AVAILCNT (KME_BASE + 1) /* INFO: %d keys current in 'publish', 'ready' and 'active' states */
50 #define KME_BUFFEROVF (KME_BASE + 2) /* ERROR: internal error, buffer overflow in %s */
51 #define KME_CHILDREN (KME_BASE + 3) /* ERROR: unable to delete %s because child objects are associated with it */
52 #define KME_CREFAIL (KME_BASE + 4) /* ERROR: failed to create '%s' */
53 #define KME_EXISTS (KME_BASE + 5) /* ERROR: object with name '%s' already exists */
54 #define KME_FLDMISMAT (KME_BASE + 6) /* ERROR: program error - number of fields returned did not match number expected */
55 #define KME_GENERATECNT (KME_BASE + 7) /* INFO: %d %ss available in 'generate' state */
56 #define KME_INSFGENKEY (KME_BASE + 8) /* INFO: %d %ss available in 'generate' state (need %d) - unable to promote until more keys generated */
57 #define KME_KEYCHSTATE (KME_BASE + 9) /* INFO: moving %d key(s) from '%s' state to '%s' state */
58 #define KME_KEYCNTSUMM (KME_BASE + 10) /* INFO: %d keys required, therefore %d new keys need to be put in 'publish' state */
59 #define KME_NOREADYKEY (KME_BASE + 11) /* WARNING: %s rollover for zone '%s' not completed as there are no keys in the 'ready' state; ods-enforcerd will try again when it runs next */
60 #define KME_NOSUCHPAR (KME_BASE + 12) /* ERROR: no such parameter with name %s */
61 #define KME_NOTFOUND (KME_BASE + 13) /* ERROR: unable to find object '%s' */
62 #define KME_NOTIMPL (KME_BASE + 14) /* WARNING: Command not implemented yet */
63 #define KME_NOTZONE (KME_BASE + 15) /* ERROR: %s is not a zone */
64 #define KME_PERMANENT (KME_BASE + 16) /* ERROR: it is not permitted to delete the permanent object %s */
65 #define KME_READYCNT (KME_BASE + 17) /* INFO: %d %ss in the 'ready' state */
66 #define KME_REMAINACT (KME_BASE + 18) /* INFO: %d %ss remaining in 'active' state */
67 #define KME_REQKEYTYPE (KME_BASE + 19) /* INFO: requesting issue of %s signing keys */
68 #define KME_RETIRECNT (KME_BASE + 20) /* INFO: %d 'active' keys will be retiring in the immediate future */
69 #define KME_SQLFAIL (KME_BASE + 21) /* ERROR: database operation failed - %s */
70 #define KME_UNKEYTYPE (KME_BASE + 22) /* ERROR: unknown key type, code %d */
71 #define KME_UNRCONCOD (KME_BASE + 23) /* WARNING: unrecognised condition code %d: code ignored */
72 #define KME_UNRKEYSTA (KME_BASE + 24) /* WARNING: key ID %d is in unrecognised state %d */
73 #define KME_PROM_PUB (KME_BASE + 25) /* INFO: Promoting %s from publish to active as this is the first pass for the zone */
74 #define KME_BACK_FATAL (KME_BASE + 26) /* ERROR: Trying to make non-backed up %s active when RequireBackup flag is set */
75 #define KME_BACK_NON_FATAL (KME_BASE + 27) /* WARNING: Making non-backed up %s active, PLEASE make sure that you know the potential problems of using keys which are not recoverable */
76 #define KME_DS_REM_ZONE (KME_BASE + 28) /* INFO: Old DS record for %s can now be removed (key moved from retired to dead state) */
77 #define KME_DS_REM_POLICY (KME_BASE + 29) /* INFO: Old DS record for %s and all zones on its policy can now be removed (key moved from retired to dead state) */
78 #define KME_ROLL_ZONE (KME_BASE + 30) /* INFO: %s has been rolled for %s */
79 #define KME_ROLL_POLICY (KME_BASE + 31) /* INFO: %s has been rolled for %s (and any zones sharing keys with %s) */
80 #define KME_TIMESHIFT (KME_BASE + 32) /* DEBUG: Timeshift in operation; ENFORCER_TIMESHIFT set to %s */
81 #define KME_MAN_ROLL_REQUIRED (KME_BASE + 33) /* INFO: Manual rollover due for %s of zone %s */
82 #define KME_WRONG_DB_VER (KME_BASE + 34) /* ERROR: database version number incompatible with software; require %d, found %d. Please run the migration scripts */
83 #define KME_DB_ADMIN (KME_BASE + 35) /* ERROR: Too many rows returned from dbadmin table; there should be only one. */
84 #define KME_DS_SUBMISSION (KME_BASE + 36) /* WARNING: New KSK has reached the ready state; please submit the DS for %s and use ods-ksmutil key ds-seen when the DS appears in the DNS. */
85 #define KME_KEY_NOT_IN_REPO (KME_BASE + 37) /* ERROR: Key %s in DB but not repository. */
86 #define KME_NEW_DS (KME_BASE + 38) /* INFO: New DS records needed for the zone %s; details will follow */
87 
88 #endif /* KSM_KMEDEF_H */