2 * Copyright (c) 2008 Apple Inc.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. Neither the name of Apple Inc. ("Apple") nor the names of
14 * its contributors may be used to endorse or promote products derived
15 * from this software without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR
21 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
25 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
26 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 * POSSIBILITY OF SUCH DAMAGE.
29 * P4: //depot/projects/trustedbsd/openbsm/libbsm/bsm_errno.c#22
32 #include <sys/cdefs.h>
33 __FBSDID("$FreeBSD$");
35 #include <sys/param.h>
37 #include <security/audit/audit.h>
39 #include <bsm/audit_errno.h>
40 #include <bsm/audit_record.h>
42 #include <sys/errno.h>
45 * Different operating systems use different numeric constants for different
46 * error numbers, and sometimes error numbers don't exist in more than one
47 * operating system. These routines convert between BSM and local error
48 * number spaces, subject to the above realities. BSM error numbers are
49 * stored in a single 8-bit character, so don't have a byte order.
51 * Don't include string definitions when this code is compiled into a kernel.
56 #if !defined(KERNEL) && !defined(_KERNEL)
57 const char *be_strerror;
61 #define ERRNO_NO_LOCAL_MAPPING -600
63 #if !defined(KERNEL) && !defined(_KERNEL)
70 * Mapping table -- please maintain in numeric sorted order with respect to
71 * the BSM constant. Today we do a linear lookup, but could switch to a
72 * binary search if it makes sense. We only ifdef errors that aren't
73 * generally available, but it does make the table a lot more ugly.
75 * XXXRW: It would be nice to have a similar ordered table mapping to BSM
76 * constant from local constant, but the order of local constants varies by
77 * OS. Really we need to build that table at compile-time but don't do that
80 * XXXRW: We currently embed English-language error strings here, but should
81 * support catalogues; these are only used if the OS doesn't have an error
82 * string using strerror(3).
84 static const struct bsm_errno bsm_errnos[] = {
85 { BSM_ERRNO_ESUCCESS, 0, ES("Success") },
86 { BSM_ERRNO_EPERM, EPERM, ES("Operation not permitted") },
87 { BSM_ERRNO_ENOENT, ENOENT, ES("No such file or directory") },
88 { BSM_ERRNO_ESRCH, ESRCH, ES("No such process") },
89 { BSM_ERRNO_EINTR, EINTR, ES("Interrupted system call") },
90 { BSM_ERRNO_EIO, EIO, ES("Input/output error") },
91 { BSM_ERRNO_ENXIO, ENXIO, ES("Device not configured") },
92 { BSM_ERRNO_E2BIG, E2BIG, ES("Argument list too long") },
93 { BSM_ERRNO_ENOEXEC, ENOEXEC, ES("Exec format error") },
94 { BSM_ERRNO_EBADF, EBADF, ES("Bad file descriptor") },
95 { BSM_ERRNO_ECHILD, ECHILD, ES("No child processes") },
96 { BSM_ERRNO_EAGAIN, EAGAIN, ES("Resource temporarily unavailable") },
97 { BSM_ERRNO_ENOMEM, ENOMEM, ES("Cannot allocate memory") },
98 { BSM_ERRNO_EACCES, EACCES, ES("Permission denied") },
99 { BSM_ERRNO_EFAULT, EFAULT, ES("Bad address") },
100 { BSM_ERRNO_ENOTBLK, ENOTBLK, ES("Block device required") },
101 { BSM_ERRNO_EBUSY, EBUSY, ES("Device busy") },
102 { BSM_ERRNO_EEXIST, EEXIST, ES("File exists") },
103 { BSM_ERRNO_EXDEV, EXDEV, ES("Cross-device link") },
104 { BSM_ERRNO_ENODEV, ENODEV, ES("Operation not supported by device") },
105 { BSM_ERRNO_ENOTDIR, ENOTDIR, ES("Not a directory") },
106 { BSM_ERRNO_EISDIR, EISDIR, ES("Is a directory") },
107 { BSM_ERRNO_EINVAL, EINVAL, ES("Invalid argument") },
108 { BSM_ERRNO_ENFILE, ENFILE, ES("Too many open files in system") },
109 { BSM_ERRNO_EMFILE, EMFILE, ES("Too many open files") },
110 { BSM_ERRNO_ENOTTY, ENOTTY, ES("Inappropriate ioctl for device") },
111 { BSM_ERRNO_ETXTBSY, ETXTBSY, ES("Text file busy") },
112 { BSM_ERRNO_EFBIG, EFBIG, ES("File too large") },
113 { BSM_ERRNO_ENOSPC, ENOSPC, ES("No space left on device") },
114 { BSM_ERRNO_ESPIPE, ESPIPE, ES("Illegal seek") },
115 { BSM_ERRNO_EROFS, EROFS, ES("Read-only file system") },
116 { BSM_ERRNO_EMLINK, EMLINK, ES("Too many links") },
117 { BSM_ERRNO_EPIPE, EPIPE, ES("Broken pipe") },
118 { BSM_ERRNO_EDOM, EDOM, ES("Numerical argument out of domain") },
119 { BSM_ERRNO_ERANGE, ERANGE, ES("Result too large") },
120 { BSM_ERRNO_ENOMSG, ENOMSG, ES("No message of desired type") },
121 { BSM_ERRNO_EIDRM, EIDRM, ES("Identifier removed") },
126 ERRNO_NO_LOCAL_MAPPING,
128 ES("Channel number out of range") },
129 { BSM_ERRNO_EL2NSYNC,
133 ERRNO_NO_LOCAL_MAPPING,
135 ES("Level 2 not synchronized") },
140 ERRNO_NO_LOCAL_MAPPING,
142 ES("Level 3 halted") },
147 ERRNO_NO_LOCAL_MAPPING,
149 ES("Level 3 reset") },
154 ERRNO_NO_LOCAL_MAPPING,
156 ES("Link number out of range") },
161 ERRNO_NO_LOCAL_MAPPING,
163 ES("Protocol driver not attached") },
168 ERRNO_NO_LOCAL_MAPPING,
170 ES("No CSI structure available") },
175 ERRNO_NO_LOCAL_MAPPING,
177 ES("Level 2 halted") },
178 { BSM_ERRNO_EDEADLK, EDEADLK, ES("Resource deadlock avoided") },
179 { BSM_ERRNO_ENOLCK, ENOLCK, ES("No locks available") },
180 { BSM_ERRNO_ECANCELED, ECANCELED, ES("Operation canceled") },
181 { BSM_ERRNO_ENOTSUP, ENOTSUP, ES("Operation not supported") },
182 { BSM_ERRNO_EDQUOT, EDQUOT, ES("Disc quota exceeded") },
187 ERRNO_NO_LOCAL_MAPPING,
189 ES("Invalid exchange") },
194 ERRNO_NO_LOCAL_MAPPING,
196 ES("Invalid request descriptor") },
201 ERRNO_NO_LOCAL_MAPPING,
203 ES("Exchange full") },
208 ERRNO_NO_LOCAL_MAPPING,
215 ERRNO_NO_LOCAL_MAPPING,
217 ES("Invalid request descriptor") },
222 ERRNO_NO_LOCAL_MAPPING,
224 ES("Invalid slot") },
225 { BSM_ERRNO_EDEADLOCK,
229 ERRNO_NO_LOCAL_MAPPING,
231 ES("Resource deadlock avoided") },
236 ERRNO_NO_LOCAL_MAPPING,
238 ES("Bad font file format") },
239 { BSM_ERRNO_EOWNERDEAD,
243 ERRNO_NO_LOCAL_MAPPING,
245 ES("Process died with the lock") },
246 { BSM_ERRNO_ENOTRECOVERABLE,
247 #ifdef ENOTRECOVERABLE
250 ERRNO_NO_LOCAL_MAPPING,
252 ES("Lock is not recoverable") },
257 ERRNO_NO_LOCAL_MAPPING,
259 ES("Device not a stream") },
264 ERRNO_NO_LOCAL_MAPPING,
266 ES("Machine is not on the network") },
271 ERRNO_NO_LOCAL_MAPPING,
273 ES("Package not installed") },
274 { BSM_ERRNO_EREMOTE, EREMOTE,
275 ES("Too many levels of remote in path") },
280 ERRNO_NO_LOCAL_MAPPING,
282 ES("Link has been severed") },
287 ERRNO_NO_LOCAL_MAPPING,
289 ES("Advertise error") },
294 ERRNO_NO_LOCAL_MAPPING,
296 ES("srmount error") },
301 ERRNO_NO_LOCAL_MAPPING,
303 ES("Communication error on send") },
308 ERRNO_NO_LOCAL_MAPPING,
310 ES("Protocol error") },
311 { BSM_ERRNO_ELOCKUNMAPPED,
315 ERRNO_NO_LOCAL_MAPPING,
317 ES("Locked lock was unmapped") },
318 { BSM_ERRNO_ENOTACTIVE,
322 ERRNO_NO_LOCAL_MAPPING,
324 ES("Facility is not active") },
325 { BSM_ERRNO_EMULTIHOP,
329 ERRNO_NO_LOCAL_MAPPING,
331 ES("Multihop attempted") },
336 ERRNO_NO_LOCAL_MAPPING,
339 { BSM_ERRNO_ENAMETOOLONG, ENAMETOOLONG, ES("File name too long") },
340 { BSM_ERRNO_EOVERFLOW, EOVERFLOW,
341 ES("Value too large to be stored in data type") },
342 { BSM_ERRNO_ENOTUNIQ,
346 ERRNO_NO_LOCAL_MAPPING,
348 ES("Given log name not unique") },
353 ERRNO_NO_LOCAL_MAPPING,
355 ES("Given f.d. invalid for this operation") },
360 ERRNO_NO_LOCAL_MAPPING,
362 ES("Remote address changed") },
367 ERRNO_NO_LOCAL_MAPPING,
369 ES("Can't access a needed shared lib") },
374 ERRNO_NO_LOCAL_MAPPING,
376 ES("Accessing a corrupted shared lib") },
381 ERRNO_NO_LOCAL_MAPPING,
383 ES(".lib section in a.out corrupted") },
388 ERRNO_NO_LOCAL_MAPPING,
390 ES("Attempting to link in too many libs") },
391 { BSM_ERRNO_ELIBEXEC,
395 ERRNO_NO_LOCAL_MAPPING,
397 ES("Attempting to exec a shared library") },
398 { BSM_ERRNO_EILSEQ, EILSEQ, ES("Illegal byte sequence") },
399 { BSM_ERRNO_ENOSYS, ENOSYS, ES("Function not implemented") },
400 { BSM_ERRNO_ELOOP, ELOOP, ES("Too many levels of symbolic links") },
401 { BSM_ERRNO_ERESTART,
405 ERRNO_NO_LOCAL_MAPPING,
407 ES("Restart syscall") },
408 { BSM_ERRNO_ESTRPIPE,
412 ERRNO_NO_LOCAL_MAPPING,
414 ES("If pipe/FIFO, don't sleep in stream head") },
415 { BSM_ERRNO_ENOTEMPTY, ENOTEMPTY, ES("Directory not empty") },
416 { BSM_ERRNO_EUSERS, EUSERS, ES("Too many users") },
417 { BSM_ERRNO_ENOTSOCK, ENOTSOCK,
418 ES("Socket operation on non-socket") },
419 { BSM_ERRNO_EDESTADDRREQ, EDESTADDRREQ,
420 ES("Destination address required") },
421 { BSM_ERRNO_EMSGSIZE, EMSGSIZE, ES("Message too long") },
422 { BSM_ERRNO_EPROTOTYPE, EPROTOTYPE,
423 ES("Protocol wrong type for socket") },
424 { BSM_ERRNO_ENOPROTOOPT, ENOPROTOOPT, ES("Protocol not available") },
425 { BSM_ERRNO_EPROTONOSUPPORT, EPROTONOSUPPORT,
426 ES("Protocol not supported") },
427 { BSM_ERRNO_ESOCKTNOSUPPORT, ESOCKTNOSUPPORT,
428 ES("Socket type not supported") },
429 { BSM_ERRNO_EOPNOTSUPP, EOPNOTSUPP, ES("Operation not supported") },
430 { BSM_ERRNO_EPFNOSUPPORT, EPFNOSUPPORT,
431 ES("Protocol family not supported") },
432 { BSM_ERRNO_EAFNOSUPPORT, EAFNOSUPPORT,
433 ES("Address family not supported by protocol family") },
434 { BSM_ERRNO_EADDRINUSE, EADDRINUSE, ES("Address already in use") },
435 { BSM_ERRNO_EADDRNOTAVAIL, EADDRNOTAVAIL,
436 ES("Can't assign requested address") },
437 { BSM_ERRNO_ENETDOWN, ENETDOWN, ES("Network is down") },
438 { BSM_ERRNO_ENETRESET, ENETRESET,
439 ES("Network dropped connection on reset") },
440 { BSM_ERRNO_ECONNABORTED, ECONNABORTED,
441 ES("Software caused connection abort") },
442 { BSM_ERRNO_ECONNRESET, ECONNRESET, ES("Connection reset by peer") },
443 { BSM_ERRNO_ENOBUFS, ENOBUFS, ES("No buffer space available") },
444 { BSM_ERRNO_EISCONN, EISCONN, ES("Socket is already connected") },
445 { BSM_ERRNO_ENOTCONN, ENOTCONN, ES("Socket is not connected") },
446 { BSM_ERRNO_ESHUTDOWN, ESHUTDOWN,
447 ES("Can't send after socket shutdown") },
448 { BSM_ERRNO_ETOOMANYREFS, ETOOMANYREFS,
449 ES("Too many references: can't splice") },
450 { BSM_ERRNO_ETIMEDOUT, ETIMEDOUT, ES("Operation timed out") },
451 { BSM_ERRNO_ECONNREFUSED, ECONNREFUSED, ES("Connection refused") },
452 { BSM_ERRNO_EHOSTDOWN, EHOSTDOWN, ES("Host is down") },
453 { BSM_ERRNO_EHOSTUNREACH, EHOSTUNREACH, ES("No route to host") },
454 { BSM_ERRNO_EALREADY, EALREADY, ES("Operation already in progress") },
455 { BSM_ERRNO_EINPROGRESS, EINPROGRESS,
456 ES("Operation now in progress") },
457 { BSM_ERRNO_ESTALE, ESTALE, ES("Stale NFS file handle") },
458 { BSM_ERRNO_EPROCLIM,
462 ERRNO_NO_LOCAL_MAPPING,
464 ES("Too many processes") },
469 ERRNO_NO_LOCAL_MAPPING,
471 ES("RPC struct is bad") },
472 { BSM_ERRNO_ERPCMISMATCH,
476 ERRNO_NO_LOCAL_MAPPING,
478 ES("RPC version wrong") },
479 { BSM_ERRNO_EPROGUNAVAIL,
483 ERRNO_NO_LOCAL_MAPPING,
485 ES("RPC prog. not avail") },
486 { BSM_ERRNO_EPROGMISMATCH,
490 ERRNO_NO_LOCAL_MAPPING,
492 ES("RPC version wrong") },
493 { BSM_ERRNO_EPROCUNAVAIL,
497 ERRNO_NO_LOCAL_MAPPING,
499 ES("Bad procedure for program") },
504 ERRNO_NO_LOCAL_MAPPING,
506 ES("Inappropriate file type or format") },
511 ERRNO_NO_LOCAL_MAPPING,
513 ES("Authenticateion error") },
514 { BSM_ERRNO_ENEEDAUTH,
518 ERRNO_NO_LOCAL_MAPPING,
520 ES("Need authenticator") },
525 ERRNO_NO_LOCAL_MAPPING,
527 ES("Attribute not found") },
532 ERRNO_NO_LOCAL_MAPPING,
534 ES("Programming error") },
535 { BSM_ERRNO_EJUSTRETURN,
539 ERRNO_NO_LOCAL_MAPPING,
542 { BSM_ERRNO_ENOIOCTL,
546 ERRNO_NO_LOCAL_MAPPING,
548 ES("ioctl not handled by this layer") },
549 { BSM_ERRNO_EDIRIOCTL,
553 ERRNO_NO_LOCAL_MAPPING,
555 ES("do direct ioctl in GEOM") },
560 ERRNO_NO_LOCAL_MAPPING,
562 ES("Device power is off") },
567 ERRNO_NO_LOCAL_MAPPING,
569 ES("Device error") },
570 { BSM_ERRNO_EBADEXEC,
574 ERRNO_NO_LOCAL_MAPPING,
576 ES("Bad executable") },
577 { BSM_ERRNO_EBADARCH,
581 ERRNO_NO_LOCAL_MAPPING,
583 ES("Bad CPU type in executable") },
584 { BSM_ERRNO_ESHLIBVERS,
588 ERRNO_NO_LOCAL_MAPPING,
590 ES("Shared library version mismatch") },
591 { BSM_ERRNO_EBADMACHO,
595 ERRNO_NO_LOCAL_MAPPING,
597 ES("Malformed Macho file") },
602 ERRNO_NO_LOCAL_MAPPING,
604 ES("Operation failed by policy") },
609 ERRNO_NO_LOCAL_MAPPING,
611 ES("RFS specific error") },
616 ERRNO_NO_LOCAL_MAPPING,
618 ES("Structure needs cleaning") },
623 ERRNO_NO_LOCAL_MAPPING,
625 ES("Not a XENIX named type file") },
630 ERRNO_NO_LOCAL_MAPPING,
632 ES("No XENIX semaphores available") },
637 ERRNO_NO_LOCAL_MAPPING,
639 ES("Is a named type file") },
640 { BSM_ERRNO_EREMOTEIO,
644 ERRNO_NO_LOCAL_MAPPING,
646 ES("Remote I/O error") },
647 { BSM_ERRNO_ENOMEDIUM,
651 ERRNO_NO_LOCAL_MAPPING,
653 ES("No medium found") },
654 { BSM_ERRNO_EMEDIUMTYPE,
658 ERRNO_NO_LOCAL_MAPPING,
660 ES("Wrong medium type") },
665 ERRNO_NO_LOCAL_MAPPING,
667 ES("Required key not available") },
668 { BSM_ERRNO_EKEYEXPIRED,
672 ERRNO_NO_LOCAL_MAPPING,
674 ES("Key has expired") },
675 { BSM_ERRNO_EKEYREVOKED,
679 ERRNO_NO_LOCAL_MAPPING,
681 ES("Key has been revoked") },
682 { BSM_ERRNO_EKEYREJECTED,
686 ERRNO_NO_LOCAL_MAPPING,
688 ES("Key was rejected by service") },
689 { BSM_ERRNO_ENOTCAPABLE,
693 ERRNO_NO_LOCAL_MAPPING,
695 ES("Capabilities insufficient") },
696 { BSM_ERRNO_ECAPMODE,
700 ERRNO_NO_LOCAL_MAPPING,
702 ES("Not permitted in capability mode") },
704 static const int bsm_errnos_count = sizeof(bsm_errnos) / sizeof(bsm_errnos[0]);
706 static const struct bsm_errno *
707 bsm_lookup_errno_local(int local_errno)
711 for (i = 0; i < bsm_errnos_count; i++) {
712 if (bsm_errnos[i].be_local_errno == local_errno)
713 return (&bsm_errnos[i]);
719 * Conversion to the BSM errno space isn't allowed to fail; we simply map to
720 * BSM_ERRNO_UNKNOWN and let the remote endpoint deal with it.
723 au_errno_to_bsm(int local_errno)
725 const struct bsm_errno *bsme;
727 bsme = bsm_lookup_errno_local(local_errno);
729 return (BSM_ERRNO_UNKNOWN);
730 return (bsme->be_bsm_errno);
733 static const struct bsm_errno *
734 bsm_lookup_errno_bsm(u_char bsm_errno)
738 for (i = 0; i < bsm_errnos_count; i++) {
739 if (bsm_errnos[i].be_bsm_errno == bsm_errno)
740 return (&bsm_errnos[i]);
746 * Converstion from a BSM error to a local error number may fail if either
747 * OpenBSM doesn't recognize the error on the wire, or because there is no
748 * appropriate local mapping.
751 au_bsm_to_errno(u_char bsm_errno, int *errorp)
753 const struct bsm_errno *bsme;
755 bsme = bsm_lookup_errno_bsm(bsm_errno);
756 if (bsme == NULL || bsme->be_local_errno == ERRNO_NO_LOCAL_MAPPING)
758 *errorp = bsme->be_local_errno;
762 #if !defined(KERNEL) && !defined(_KERNEL)
764 au_strerror(u_char bsm_errno)
766 const struct bsm_errno *bsme;
768 bsme = bsm_lookup_errno_bsm(bsm_errno);
770 return ("Unrecognized BSM error");
771 if (bsme->be_local_errno != ERRNO_NO_LOCAL_MAPPING)
772 return (strerror(bsme->be_local_errno));
773 return (bsme->be_strerror);