sys/netsmb/smb_subr.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2000-2001 Boris Popov
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  *
  28  * $FreeBSD$
  29  */
  30 #ifndef _NETSMB_SMB_SUBR_H_
  31 #define _NETSMB_SMB_SUBR_H_
  32
  33 #ifndef _KERNEL
  34 #error "This file shouldn't be included from userland programs"
  35 #endif
  36
  37 #ifdef MALLOC_DECLARE
  38 MALLOC_DECLARE(M_SMBTEMP);
  39 #endif
  40
  41 #define SMBERROR(format, args...) printf("%s: "format, __func__ ,## args)
  42 #define SMBPANIC(format, args...) printf("%s: "format, __func__ ,## args)
  43
  44 #ifdef SMB_SOCKET_DEBUG
  45 #define SMBSDEBUG(format, args...) printf("%s: "format, __func__ ,## args)
  46 #else
  47 #define SMBSDEBUG(format, args...)
  48 #endif
  49
  50 #ifdef SMB_IOD_DEBUG
  51 #define SMBIODEBUG(format, args...) printf("%s: "format, __func__ ,## args)
  52 #else
  53 #define SMBIODEBUG(format, args...)
  54 #endif
  55
  56 #ifdef SMB_SOCKETDATA_DEBUG
  57 void m_dumpm(struct mbuf *m);
  58 #else
  59 #define m_dumpm(m)
  60 #endif
  61
  62 #define SMB_SIGMASK(set)                                                \
  63         (SIGISMEMBER(set, SIGINT) || SIGISMEMBER(set, SIGTERM) ||       \
  64          SIGISMEMBER(set, SIGHUP) || SIGISMEMBER(set, SIGKILL) ||       \
  65          SIGISMEMBER(set, SIGQUIT))
  66
  67 #define smb_suser(cred) priv_check_cred(cred, PRIV_NETSMB)
  68
  69 /*
  70  * Compatibility wrappers for simple locks
  71  */
  72
  73 #include <sys/lock.h>
  74 #include <sys/mutex.h>
  75
  76 #define smb_slock                       mtx
  77 #define smb_sl_init(mtx, desc)          mtx_init(mtx, desc, NULL, MTX_DEF)
  78 #define smb_sl_destroy(mtx)             mtx_destroy(mtx)
  79 #define smb_sl_lock(mtx)                mtx_lock(mtx)
  80 #define smb_sl_unlock(mtx)              mtx_unlock(mtx)
  81
  82 #define SMB_STRFREE(p)  do { if (p) smb_strfree(p); } while(0)
  83
  84 typedef u_int16_t       smb_unichar;
  85 typedef smb_unichar     *smb_uniptr;
  86
  87 /*
  88  * Crediantials of user/process being processing in the connection procedures
  89  */
  90 struct smb_cred {
  91         struct thread * scr_td;
  92         struct ucred *  scr_cred;
  93 };
  94
  95 extern smb_unichar smb_unieol;
  96
  97 struct mbchain;
  98 struct smb_vc;
  99 struct smb_rq;
 100
 101 void smb_makescred(struct smb_cred *scred, struct thread *td, struct ucred *cred);
 102 int  smb_td_intr(struct thread *);
 103 char *smb_strdup(const char *s);
 104 void *smb_memdup(const void *umem, int len);
 105 char *smb_strdupin(char *s, size_t maxlen);
 106 void *smb_memdupin(void *umem, size_t len);
 107 void smb_strtouni(u_int16_t *dst, const char *src);
 108 void smb_strfree(char *s);
 109 void smb_memfree(void *s);
 110 void *smb_zmalloc(size_t size, struct malloc_type *type, int flags);
 111
 112 int  smb_calcmackey(struct smb_vc *vcp);
 113 int  smb_encrypt(const u_char *apwd, u_char *C8, u_char *RN);
 114 int  smb_ntencrypt(const u_char *apwd, u_char *C8, u_char *RN);
 115 int  smb_maperror(int eclass, int eno);
 116 int  smb_put_dmem(struct mbchain *mbp, struct smb_vc *vcp,
 117         const char *src, size_t len, int caseopt);
 118 int  smb_put_dstring(struct mbchain *mbp, struct smb_vc *vcp,
 119         const char *src, int caseopt);
 120 int  smb_put_string(struct smb_rq *rqp, const char *src);
 121 int  smb_put_asunistring(struct smb_rq *rqp, const char *src);
 122 int  smb_rq_sign(struct smb_rq *rqp);
 123 int  smb_rq_verify(struct smb_rq *rqp);
 124
 125 #endif /* !_NETSMB_SMB_SUBR_H_ */