smb-errors.c

Go to the documentation of this file.

/*
 * Copyright (C) 1996-2023 The Squid Software Foundation and contributors
 *
 * Squid software is distributed under GPLv2+ license and includes
 * contributions from numerous individuals and organizations.
 * Please see the COPYING and CONTRIBUTORS files for details.
 */
 
/* UNIX SMBlib NetBIOS implementation
 
   Version 1.0
   SMBlib Error values etc ...
 
   Copyright (C) Richard Sharpe, Andrew Tridgell, and Merik Karman, 1996
*/
 
/*
   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
   the Free Software Foundation; either version 2 of the License, or
   (at your option) any later version.
 
   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.
 
   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
 
/* This code ripped out of smbclient, where it was attributed to Merik  */
/* Karman merik@blackadder.dsh.oz.au                                    */
/* Modified by Richard Sharpe to try to make it more bullit proof and   */
/* ensure we don't overwrite strings when not passed enough space. Also */
/* added code to say unknown error codes if we see any                  */
 
#include "squid.h"
 
typedef struct {
    char *name;
    int code;
    char *message;
} err_code_struct;
 
/* Dos Error Messages */
err_code_struct dos_msgs[] = {
    {"ERRbadfunc",1,"Invalid function."},
    {"ERRbadfile",2,"File not found."},
    {"ERRbadpath",3,"Directory invalid."},
    {"ERRnofids",4,"No file descriptors available"},
    {"ERRnoaccess",5,"Access denied."},
    {"ERRbadfid",6,"Invalid file handle."},
    {"ERRbadmcb",7,"Memory control blocks destroyed."},
    {"ERRnomem",8,"Insufficient server memory to perform the requested function."}
    ,
    {"ERRbadmem",9,"Invalid memory block address."},
    {"ERRbadenv",10,"Invalid environment."},
    {"ERRbadformat",11,"Invalid format."},
    {"ERRbadaccess",12,"Invalid open mode."},
    {"ERRbaddata",13,"Invalid data."},
    {"ERR",14,"reserved."},
    {"ERRbaddrive",15,"Invalid drive specified."},
    {"ERRremcd",16,"A Delete Directory request attempted to remove the server's current directory."},
    {"ERRdiffdevice",17,"Not same device."},
    {"ERRnofiles",18,"A File Search command can find no more files matching the specified criteria."},
    {"ERRbadshare",32,"The sharing mode specified for an Open conflicts with existing FIDs on the file."},
    {"ERRlock",33,"A Lock request conflicted with an existing lock or specified an invalid mode, or an Unlock requested attempted to remove a lock held by another process."},
    {"ERRbaddevtyp",66,"The device type is incorrect for a tree connect."},
    {"ERRbadnetnam",67,"The network name is incorrect or inappropriate."},
    {"ERRfilexists",80,"The file named in a Create Directory, Make New File or Link request already exists."},
    {"ERRbadpipe",230,"Pipe invalid."},
    {"ERRpipebusy",231,"All instances of the requested pipe are busy."},
    {"ERRpipeclosing",232,"Pipe close in progress."},
    {"ERRnotconnected",233,"No process on other end of pipe."},
    {"ERRmoredata",234,"There is more data to be returned."},
    {"ERRinvapi", 2142, "The API is invalid."},
    {NULL,-1,NULL}
};
 
/* Server Error Messages */
err_code_struct server_msgs[] = {
    {"ERRerror",1,"Non-specific error code."},
    {"ERRbadpw",2,"Bad password - name/password pair in a Tree Connect or Session Setup are invalid."},
    {"ERRbadtype",3,"reserved."},
    {"ERRaccess",4,"Network access denied. The requester does not have the necessary access rights within the specified context for the requested function. The context is defined by the TID or the UID."},
    {"ERRinvnid",5,"The tree ID (TID) specified in a command was invalid."},
    {"ERRinvnetname",6,"Invalid network name in tree connect."},
    {"ERRinvdevice",7,"Invalid device - printer request made to non-printer connection or non-printer request made to printer connection."},
    {"ERRqfull",49,"Print queue full (files) -- returned by open print file."},
    {"ERRqtoobig",50,"Print queue full -- no space."},
    {"ERRqeof",51,"EOF on print queue dump."},
    {"ERRinvpfid",52,"Invalid print file FID."},
    {"ERRsmbcmd",64,"The server did not recognize the command received."},
    {"ERRsrverror",65,"The server encountered an internal error, e.g., system file unavailable."},
    {"ERRfilespecs",67,"The file handle (FID) and pathname parameters contained an invalid  combination of values."},
    {"ERRreserved",68,"reserved."},
    {"ERRbadpermits",69,"The access permissions specified for a file or directory are not a valid combination. The server cannot set the requested attribute."},
    {"ERRreserved",70,"reserved."},
    {"ERRsetattrmode",71,"The attribute mode in the Set File Attribute request is invalid."},
    {"ERRpaused",81,"Server is paused."},
    {"ERRmsgoff",82,"Not receiving messages."},
    {"ERRnoroom",83,"No room to buffer message."},
    {"ERRrmuns",87,"Too many remote user names."},
    {"ERRtimeout",88,"Operation timed out."},
    {"ERRnoresource",89,"No resources currently available for request."},
    {"ERRtoomanyuids",90,"Too many UIDs active on this session."},
    {"ERRbaduid",91,"The UID is not known as a valid ID on this session."},
    {"ERRusempx",250,"Temp unable to support Raw, use MPX mode."},
    {"ERRusestd",251,"Temp unable to support Raw, use standard read/write."},
    {"ERRcontmpx",252,"Continue in MPX mode."},
    {"ERRreserved",253,"reserved."},
    {"ERRreserved",254,"reserved."},
    {"ERRpwdexp",2242,"Password has expired."},
    {"ERRnosupport",0xFFFF,"Function not supported."},
    {NULL,-1,NULL}
};
 
/* Hard Error Messages */
err_code_struct hard_msgs[] = {
    {"ERRnowrite",19,"Attempt to write on write-protected diskette."},
    {"ERRbadunit",20,"Unknown unit."},
    {"ERRnotready",21,"Drive not ready."},
    {"ERRbadcmd",22,"Unknown command."},
    {"ERRdata",23,"Data error (CRC)."},
    {"ERRbadreq",24,"Bad request structure length."},
    {"ERRseek",25,"Seek error."},
    {"ERRbadmedia",26,"Unknown media type."},
    {"ERRbadsector",27,"Sector not found."},
    {"ERRnopaper",28,"Printer out of paper."},
    {"ERRwrite",29,"Write fault."},
    {"ERRread",30,"Read fault."},
    {"ERRgeneral",31,"General failure."},
    {"ERRbadshare",32,"A open conflicts with an existing open."},
    {"ERRlock",33,"A Lock request conflicted with an existing lock or specified an invalid mode, or an Unlock requested attempted to remove a lock held by another process."},
    {"ERRwrongdisk",34,"The wrong disk was found in a drive."},
    {"ERRFCBUnavail",35,"No FCBs are available to process request."},
    {"ERRsharebufexc",36,"A sharing buffer has been exceeded."},
    {"ERRdiskfull",39,"The disk is full."},
    {NULL,-1,NULL}
};
 
struct {
    int code;
    char *class;
    err_code_struct *err_msgs;
} err_classes[] = {
    {0,"SUCCESS",NULL},
    {0x01,"ERRDOS",dos_msgs},
    {0x02,"ERRSRV",server_msgs},
    {0x03,"ERRHRD",hard_msgs},
    {0x04,"ERRXOS",NULL},
    {0xE1,"ERRRMX1",NULL},
    {0xE2,"ERRRMX2",NULL},
    {0xE3,"ERRRMX3",NULL},
    {0xFF,"ERRCMD",NULL},
    {-1,NULL,NULL}
};
 
/* Return in the string an error message after decoding the class and code */
 
int SMB_Get_SMB_Error_Msg(int err_class, int err_code, char *msg_buf, int len)
 
{
    int i,j;
    char internal_buf[80];
 
    for (i=0; err_classes[i].class; i++)
 
        if (err_classes[i].code == err_class) {
 
            if (err_classes[i].err_msgs) {
 
                err_code_struct *err = err_classes[i].err_msgs;
 
                for (j=0; err[j].name; j++)
 
                    if (err_code == err[j].code) {
 
                        /* Put together the message */
 
                        strncpy(msg_buf, err_classes[i].class, len);
                        strncat(msg_buf, " - ", len - strlen(msg_buf));
                        strncat(msg_buf, err[j].name, len - strlen(msg_buf));
                        strncat(msg_buf, " (", len - strlen(msg_buf));
                        strncat(msg_buf, err[j].message, len - strlen(msg_buf));
                        strncat(msg_buf, ").", len - strlen(msg_buf));
 
                        return(strlen(msg_buf));
                    }
 
                /* We only get here if the error code is one we don't know about */
                /* Just print out the code etc ...                               */
 
                strncpy(msg_buf, err_classes[i].class, len);
                strncat(msg_buf, " - ", len - strlen(msg_buf));
                snprintf(internal_buf, sizeof(internal_buf)-1, "%d", err_code);
                strncat(msg_buf, internal_buf, len - strlen(msg_buf));
                strncat(msg_buf, " (Unknown error code).", len - strlen(msg_buf));
 
                return(strlen(msg_buf));
 
            } else {
 
                strncpy(msg_buf, err_classes[i].class, len);
                strncat(msg_buf, " - ", len - strlen(msg_buf));
                snprintf(internal_buf, sizeof(internal_buf)-1, "%d", err_code);
                strncat(msg_buf, internal_buf, len - strlen(msg_buf));
 
                return(strlen(msg_buf));
 
            }
 
        }
 
    /* If we get here, we did not recognize the error class */
 
    snprintf(internal_buf, sizeof(internal_buf)-1, "%d", err_class);
    strncat(msg_buf, internal_buf, len - strlen(msg_buf));
    strncat(msg_buf, " (Unknown Error Class) - ", len - strlen(msg_buf));
    snprintf(internal_buf, sizeof(internal_buf)-1, "%d", err_code);
    strncat(msg_buf, internal_buf, len - strlen(msg_buf));
    strncat(msg_buf, "(error code).", len - strlen(msg_buf));
 
    return(strlen(msg_buf));
 
}