Spelling.
[nivanova/samba-autobuild/.git] / source3 / libsmb / clierror.c
index bb2bbd0dfff60ef6ebadb0d584ef207b6f03a12d..656671823c40ead3257da7af4c55321d69a84a6d 100644 (file)
@@ -1,8 +1,8 @@
 /* 
-   Unix SMB/Netbios implementation.
-   Version 3.0
+   Unix SMB/CIFS implementation.
    client error handling routines
    Copyright (C) Andrew Tridgell 1994-1998
+   Copyright (C) Jelmer Vernooij 2003
    
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
 
 #include "includes.h"
 
-extern int DEBUGLEVEL;
-
 /*****************************************************
  RAP error codes - a small start but will be extended.
+
+ XXX: Perhaps these should move into a common function because they're
+ duplicated in clirap2.c
+
 *******************************************************/
 
-static struct
+static const struct
 {
   int err;
-  char *message;
+  const char *message;
 } rap_errmap[] =
 {
-  {5,    "User has insufficient privilege" },
-  {86,   "The specified password is invalid" },
-  {2226, "Operation only permitted on a Primary Domain Controller"  },
-  {2242, "The password of this user has expired." },
-  {2243, "The password of this user cannot change." },
-  {2244, "This password cannot be used now (password history conflict)." },
-  {2245, "The password is shorter than required." },
-  {2246, "The password of this user is too recent to change."},
+  {5,    "RAP5: User has insufficient privilege" },
+  {50,   "RAP50: Not supported by server" },
+  {65,   "RAP65: Access denied" },
+  {86,   "RAP86: The specified password is invalid" },
+  {2220, "RAP2220: Group does not exist" },
+  {2221, "RAP2221: User does not exist" },
+  {2226, "RAP2226: Operation only permitted on a Primary Domain Controller"  },
+  {2237, "RAP2237: User is not in group" },
+  {2242, "RAP2242: The password of this user has expired." },
+  {2243, "RAP2243: The password of this user cannot change." },
+  {2244, "RAP2244: This password cannot be used now (password history conflict)." },
+  {2245, "RAP2245: The password is shorter than required." },
+  {2246, "RAP2246: The password of this user is too recent to change."},
 
   /* these really shouldn't be here ... */
   {0x80, "Not listening on called name"},
@@ -56,9 +63,9 @@ static struct
 /****************************************************************************
   return a description of an SMB error
 ****************************************************************************/
-static char *cli_smb_errstr(struct cli_state *cli)
+static const char *cli_smb_errstr(struct cli_state *cli)
 {
-       return smb_errstr(cli->inbuf);
+       return smb_dos_errstr(cli->inbuf);
 }
 
 /***************************************************************************
@@ -67,110 +74,122 @@ static char *cli_smb_errstr(struct cli_state *cli)
  in which case they can be safely ignored.
 ****************************************************************************/
     
-char *cli_errstr(struct cli_state *cli)
+const char *cli_errstr(struct cli_state *cli)
 {   
-       static fstring error_message;
+       static fstring cli_error_message;
        uint32 flgs2 = SVAL(cli->inbuf,smb_flg2), errnum;
-        uint8 errclass;
-        int i;
+       uint8 errclass;
+       int i;
 
-        /* Case #1: 32-bit NT errors */
+       if (!cli->initialised) {
+               fstrcpy(cli_error_message, "[Programmer's error] cli_errstr called on unitialized cli_stat struct!\n");
+               return cli_error_message;
+       }
 
-       if (flgs2 & FLAGS2_32_BIT_ERROR_CODES) {
-                uint32 status = IVAL(cli->inbuf,smb_rcls);
+       /* Was it server socket error ? */
+       if (cli->fd == -1 && cli->smb_rw_error) {
+               switch(cli->smb_rw_error) {
+                       case READ_TIMEOUT:
+                               slprintf(cli_error_message, sizeof(cli_error_message) - 1,
+                                       "Call timed out: server did not respond after %d milliseconds",
+                                       cli->timeout);
+                               break;
+                       case READ_EOF:
+                               slprintf(cli_error_message, sizeof(cli_error_message) - 1,
+                                       "Call returned zero bytes (EOF)" );
+                               break;
+                       case READ_ERROR:
+                               slprintf(cli_error_message, sizeof(cli_error_message) - 1,
+                                       "Read error: %s", strerror(errno) );
+                               break;
+                       case WRITE_ERROR:
+                               slprintf(cli_error_message, sizeof(cli_error_message) - 1,
+                                       "Write error: %s", strerror(errno) );
+                               break;
+                       case READ_BAD_SIG:
+                               slprintf(cli_error_message, sizeof(cli_error_message) - 1,
+                                       "Server packet had invalid SMB signature!");
+                               break;
+                       default:
+                               slprintf(cli_error_message, sizeof(cli_error_message) - 1,
+                                       "Unknown error code %d\n", cli->smb_rw_error );
+                               break;
+               }
+               return cli_error_message;
+       }
 
-                return get_nt_error_msg(status);
-        }
+       /* Case #1: RAP error */
+       if (cli->rap_error) {
+               for (i = 0; rap_errmap[i].message != NULL; i++) {
+                       if (rap_errmap[i].err == cli->rap_error) {
+                               return rap_errmap[i].message;
+                       }
+               }
 
-        cli_dos_error(cli, &errclass, &errnum);
+               slprintf(cli_error_message, sizeof(cli_error_message) - 1, "RAP code %d",
+                       cli->rap_error);
 
-        /* Case #2: SMB error */
+               return cli_error_message;
+       }
 
-        if (errclass != 0)
-                return cli_smb_errstr(cli);
+       /* Case #2: 32-bit NT errors */
+       if (flgs2 & FLAGS2_32_BIT_ERROR_CODES) {
+               NTSTATUS status = NT_STATUS(IVAL(cli->inbuf,smb_rcls));
 
-        /* Case #3: RAP error */
+               return nt_errstr(status);
+        }
 
-       for (i = 0; rap_errmap[i].message != NULL; i++) {
-               if (rap_errmap[i].err == cli->rap_error) {
-                       return rap_errmap[i].message;
-               }
-       } 
+       cli_dos_error(cli, &errclass, &errnum);
 
-       slprintf(error_message, sizeof(error_message) - 1, "code %d", 
-                 cli->rap_error);
+       /* Case #3: SMB error */
 
-       return error_message;
+       return cli_smb_errstr(cli);
 }
 
-/* Return the 32-bit NT status code from the last packet */
 
-uint32 cli_nt_error(struct cli_state *cli)
+/* Return the 32-bit NT status code from the last packet */
+NTSTATUS cli_nt_error(struct cli_state *cli)
 {
         int flgs2 = SVAL(cli->inbuf,smb_flg2);
 
        if (!(flgs2 & FLAGS2_32_BIT_ERROR_CODES)) {
-
-                /* Eek!  We've requested a NT error when the packet that
-                   came back does not contain one.  What do we return 
-                   here? */
-
-                DEBUG(1, ("ERROR: cli_error() called to read a status code "
-                          "from a packet that does not contain one!\n"));
-
-                return NT_STATUS_UNSUCCESSFUL;
+               int class  = CVAL(cli->inbuf,smb_rcls);
+               int code  = SVAL(cli->inbuf,smb_err);
+               return dos_to_ntstatus(class, code);
         }
 
-        return IVAL(cli->inbuf,smb_rcls);
+        return NT_STATUS(IVAL(cli->inbuf,smb_rcls));
 }
 
+
 /* Return the DOS error from the last packet - an error class and an error
    code. */
-
-void cli_dos_error(struct cli_state *cli, uint8 *eclass, uint32 *num)
+void cli_dos_error(struct cli_state *cli, uint8 *eclass, uint32 *ecode)
 {
        int  flgs2;
        char rcls;
        int code;
 
-       if (eclass) 
-                *eclass = 0;
-
-       if (num) 
-                *num = 0;
-
-       if(!cli->initialised)
-               return;
-
-       if(!cli->inbuf)
-               return;
+       if(!cli->initialised) return;
 
        flgs2 = SVAL(cli->inbuf,smb_flg2);
 
        if (flgs2 & FLAGS2_32_BIT_ERROR_CODES) {
-                /* Eek!  We've requested a DOS error when the packet that
-                   came back does not contain one.  What do we return 
-                   here? */
-
-                DEBUG(1, ("ERROR: cli_error() called to read a dos error code "
-                          "from a packet that does not contain one!\n"));
-
+               NTSTATUS ntstatus = NT_STATUS(IVAL(cli->inbuf, smb_rcls));
+               ntstatus_to_dos(ntstatus, eclass, ecode);
                 return;
         }
 
        rcls  = CVAL(cli->inbuf,smb_rcls);
        code  = SVAL(cli->inbuf,smb_err);
 
-       if (rcls == 0) 
-                return;
-
        if (eclass) *eclass = rcls;
-       if (num   ) *num    = code;
+       if (ecode) *ecode    = code;
 }
 
 /* Return a UNIX errno from a dos error class, error number tuple */
 
-int cli_errno_from_dos(uint8 eclass, uint32 num)
+static int cli_errno_from_dos(uint8 eclass, uint32 num)
 {
        if (eclass == ERRDOS) {
                switch (num) {
@@ -201,29 +220,126 @@ int cli_errno_from_dos(uint8 eclass, uint32 num)
 }
 
 /* Return a UNIX errno from a NT status code */
-
-int cli_errno_from_nt(uint32 status)
+static struct {
+       NTSTATUS status;
+       int error;
+} nt_errno_map[] = {
+        {NT_STATUS_ACCESS_VIOLATION, EACCES},
+        {NT_STATUS_INVALID_HANDLE, EBADF},
+        {NT_STATUS_ACCESS_DENIED, EACCES},
+        {NT_STATUS_OBJECT_NAME_NOT_FOUND, ENOENT},
+        {NT_STATUS_SHARING_VIOLATION, EBUSY},
+        {NT_STATUS_OBJECT_PATH_INVALID, ENOTDIR},
+        {NT_STATUS_OBJECT_NAME_COLLISION, EEXIST},
+        {NT_STATUS_PATH_NOT_COVERED, ENOENT},
+       {NT_STATUS_UNSUCCESSFUL, EINVAL},
+       {NT_STATUS_NOT_IMPLEMENTED, ENOSYS},
+       {NT_STATUS_IN_PAGE_ERROR, EFAULT}, 
+       {NT_STATUS_BAD_NETWORK_NAME, ENOENT},
+#ifdef EDQUOT
+       {NT_STATUS_PAGEFILE_QUOTA, EDQUOT},
+       {NT_STATUS_QUOTA_EXCEEDED, EDQUOT},
+       {NT_STATUS_REGISTRY_QUOTA_LIMIT, EDQUOT},
+       {NT_STATUS_LICENSE_QUOTA_EXCEEDED, EDQUOT},
+#endif
+#ifdef ETIME
+       {NT_STATUS_TIMER_NOT_CANCELED, ETIME},
+#endif
+       {NT_STATUS_INVALID_PARAMETER, EINVAL},
+       {NT_STATUS_NO_SUCH_DEVICE, ENODEV},
+       {NT_STATUS_NO_SUCH_FILE, ENOENT},
+#ifdef ENODATA
+       {NT_STATUS_END_OF_FILE, ENODATA}, 
+#endif
+#ifdef ENOMEDIUM
+       {NT_STATUS_NO_MEDIA_IN_DEVICE, ENOMEDIUM}, 
+       {NT_STATUS_NO_MEDIA, ENOMEDIUM},
+#endif
+       {NT_STATUS_NONEXISTENT_SECTOR, ESPIPE}, 
+        {NT_STATUS_NO_MEMORY, ENOMEM},
+       {NT_STATUS_CONFLICTING_ADDRESSES, EADDRINUSE},
+       {NT_STATUS_NOT_MAPPED_VIEW, EINVAL},
+       {NT_STATUS_UNABLE_TO_FREE_VM, EADDRINUSE},
+       {NT_STATUS_ACCESS_DENIED, EACCES}, 
+       {NT_STATUS_BUFFER_TOO_SMALL, ENOBUFS},
+       {NT_STATUS_WRONG_PASSWORD, EACCES},
+       {NT_STATUS_LOGON_FAILURE, EACCES},
+       {NT_STATUS_INVALID_WORKSTATION, EACCES},
+       {NT_STATUS_INVALID_LOGON_HOURS, EACCES},
+       {NT_STATUS_PASSWORD_EXPIRED, EACCES},
+       {NT_STATUS_ACCOUNT_DISABLED, EACCES},
+       {NT_STATUS_DISK_FULL, ENOSPC},
+       {NT_STATUS_INVALID_PIPE_STATE, EPIPE},
+       {NT_STATUS_PIPE_BUSY, EPIPE},
+       {NT_STATUS_PIPE_DISCONNECTED, EPIPE},
+       {NT_STATUS_PIPE_NOT_AVAILABLE, ENOSYS},
+       {NT_STATUS_FILE_IS_A_DIRECTORY, EISDIR},
+       {NT_STATUS_NOT_SUPPORTED, ENOSYS},
+       {NT_STATUS_NOT_A_DIRECTORY, ENOTDIR},
+       {NT_STATUS_DIRECTORY_NOT_EMPTY, ENOTEMPTY},
+       {NT_STATUS_NETWORK_UNREACHABLE, ENETUNREACH},
+       {NT_STATUS_HOST_UNREACHABLE, EHOSTUNREACH},
+       {NT_STATUS_CONNECTION_ABORTED, ECONNABORTED},
+       {NT_STATUS_CONNECTION_REFUSED, ECONNREFUSED},
+       {NT_STATUS_TOO_MANY_LINKS, EMLINK},
+       {NT_STATUS_NETWORK_BUSY, EBUSY},
+       {NT_STATUS_DEVICE_DOES_NOT_EXIST, ENODEV},
+#ifdef ELIBACC
+       {NT_STATUS_DLL_NOT_FOUND, ELIBACC},
+#endif
+       {NT_STATUS_PIPE_BROKEN, EPIPE},
+       {NT_STATUS_REMOTE_NOT_LISTENING, ECONNREFUSED},
+       {NT_STATUS_NETWORK_ACCESS_DENIED, EACCES},
+       {NT_STATUS_TOO_MANY_OPENED_FILES, EMFILE},
+#ifdef EPROTO
+       {NT_STATUS_DEVICE_PROTOCOL_ERROR, EPROTO},
+#endif
+       {NT_STATUS_FLOAT_OVERFLOW, ERANGE},
+       {NT_STATUS_FLOAT_UNDERFLOW, ERANGE},
+       {NT_STATUS_INTEGER_OVERFLOW, ERANGE},
+       {NT_STATUS_MEDIA_WRITE_PROTECTED, EROFS},
+       {NT_STATUS_PIPE_CONNECTED, EISCONN},
+       {NT_STATUS_MEMORY_NOT_ALLOCATED, EFAULT},
+       {NT_STATUS_FLOAT_INEXACT_RESULT, ERANGE},
+       {NT_STATUS_ILL_FORMED_PASSWORD, EACCES},
+       {NT_STATUS_PASSWORD_RESTRICTION, EACCES},
+       {NT_STATUS_ACCOUNT_RESTRICTION, EACCES},
+       {NT_STATUS_PORT_CONNECTION_REFUSED, ECONNREFUSED},
+       {NT_STATUS_NAME_TOO_LONG, ENAMETOOLONG},
+       {NT_STATUS_REMOTE_DISCONNECT, ESHUTDOWN},
+       {NT_STATUS_CONNECTION_DISCONNECTED, ECONNABORTED},
+       {NT_STATUS_CONNECTION_RESET, ENETRESET},
+#ifdef ENOTUNIQ
+       {NT_STATUS_IP_ADDRESS_CONFLICT1, ENOTUNIQ},
+       {NT_STATUS_IP_ADDRESS_CONFLICT2, ENOTUNIQ},
+#endif
+       {NT_STATUS_PORT_MESSAGE_TOO_LONG, EMSGSIZE},
+       {NT_STATUS_PROTOCOL_UNREACHABLE, ENOPROTOOPT},
+       {NT_STATUS_ADDRESS_ALREADY_EXISTS, EADDRINUSE},
+       {NT_STATUS_PORT_UNREACHABLE, EHOSTUNREACH},
+       {NT_STATUS_IO_TIMEOUT, ETIMEDOUT},
+       {NT_STATUS_RETRY, EAGAIN},
+#ifdef ECOMM
+       {NT_STATUS_NET_WRITE_FAULT, ECOMM},
+#endif
+
+       {NT_STATUS(0), 0}
+};
+
+static int cli_errno_from_nt(NTSTATUS status)
 {
-        DEBUG(10,("cli_errno_from_nt: 32 bit codes: code=%08x\n", status));
+       int i;
+        DEBUG(10,("cli_errno_from_nt: 32 bit codes: code=%08x\n", NT_STATUS_V(status)));
 
         /* Status codes without this bit set are not errors */
 
-        if (!(status & 0xc0000000))
+        if (!(NT_STATUS_V(status) & 0xc0000000))
                 return 0;
 
-        switch (status) {
-        case NT_STATUS_ACCESS_VIOLATION: return EACCES;
-        case NT_STATUS_NO_SUCH_FILE: return ENOENT;
-        case NT_STATUS_NO_SUCH_DEVICE: return ENODEV;
-        case NT_STATUS_INVALID_HANDLE: return EBADF;
-        case NT_STATUS_NO_MEMORY: return ENOMEM;
-        case NT_STATUS_ACCESS_DENIED: return EACCES;
-        case NT_STATUS_OBJECT_NAME_NOT_FOUND: return ENOENT;
-        case NT_STATUS_SHARING_VIOLATION: return EBUSY;
-        case NT_STATUS_OBJECT_PATH_INVALID: return ENOTDIR;
-        case NT_STATUS_OBJECT_NAME_COLLISION: return EEXIST;
-        case NT_STATUS_PATH_NOT_COVERED: return ENOENT;
-        }
+       for (i=0;nt_errno_map[i].error;i++) {
+               if (NT_STATUS_V(nt_errno_map[i].status) ==
+                   NT_STATUS_V(status)) return nt_errno_map[i].error;
+       }
 
         /* for all other cases - a default code */
         return EINVAL;
@@ -234,9 +350,9 @@ int cli_errno_from_nt(uint32 status)
 
 int cli_errno(struct cli_state *cli)
 {
-        uint32 status;
+        NTSTATUS status;
 
-        if (cli_is_dos_error) {
+        if (cli_is_dos_error(cli)) {
                 uint8 eclass;
                 uint32 ecode;
 
@@ -255,12 +371,16 @@ BOOL cli_is_error(struct cli_state *cli)
 {
        uint32 flgs2 = SVAL(cli->inbuf,smb_flg2), rcls = 0;
 
-        if (flgs2 & FLAGS2_32_BIT_ERROR_CODES)
+        if (flgs2 & FLAGS2_32_BIT_ERROR_CODES) {
+                /* Return error is error bits are set */
                 rcls = IVAL(cli->inbuf, smb_rcls);
-        else
-                rcls = CVAL(cli->inbuf, smb_rcls);
+                return (rcls & 0xF0000000) == 0xC0000000;
+        }
+                
+        /* Return error if error class in non-zero */
 
-        return (rcls != 0);
+        rcls = CVAL(cli->inbuf, smb_rcls);
+        return rcls != 0;
 }
 
 /* Return true if the last error was an NT error */