path: root/source/sam/idmap_util.c

/* 
   Unix SMB/CIFS implementation.
   ID Mapping
   Copyright (C) Simo Sorce 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
   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.*/

#include "includes.h"

#undef DBGC_CLASS
#define DBGC_CLASS DBGC_IDMAP

/**********************************************************************
**********************************************************************/

BOOL idmap_get_free_ugid_range(uint32 *low, uint32 *high)
{
	uid_t u_low, u_high;
	gid_t g_low, g_high;

	if (!lp_idmap_uid(&u_low, &u_high) || !lp_idmap_gid(&g_low, &g_high)) {
		return False;
	}
	
	*low  = (u_low < g_low)   ? u_low  : g_low;
	*high = (u_high < g_high) ? u_high : g_high;
	
	return True;
}

/******************************************************************
 Get the the non-algorithmic RID range if idmap range are defined
******************************************************************/

BOOL idmap_get_free_rid_range(uint32 *low, uint32 *high)
{
	uint32 id_low, id_high;

	if (!lp_enable_rid_algorithm()) {
		*low = BASE_RID;
		*high = (uint32)-1;
	}

	if (!idmap_get_free_ugid_range(&id_low, &id_high)) {
		return False;
	}

	*low = fallback_pdb_uid_to_user_rid(id_low);
	if (fallback_pdb_user_rid_to_uid((uint32)-1) < id_high) {
		*high = (uint32)-1;
	} else {
		*high = fallback_pdb_uid_to_user_rid(id_high);
	}

	return True;
}

/**********************************************************************
 Get the free RID base if idmap is configured, otherwise return 0
**********************************************************************/

uint32 idmap_get_free_rid_base(void)
{
	uint32 low, high;
	if (idmap_get_free_rid_range(&low, &high)) {
		return low;
	}
	return 0;
}

/**********************************************************************
**********************************************************************/

BOOL idmap_check_ugid_is_in_free_range(uint32 id)
{
	uint32 low, high;

	if (!idmap_get_free_ugid_range(&low, &high)) {
		return False;
	}
	if (id < low || id > high) {
		return False;
	}
	return True;
}

/**********************************************************************
**********************************************************************/

BOOL idmap_check_rid_is_in_free_range(uint32 rid)
{
	uint32 low, high;

	if (!idmap_get_free_rid_range(&low, &high)) {
		return False;
	}
	if (rid < algorithmic_rid_base()) {
		return True;
	}

	if (rid < low || rid > high) {
		return False;
	}

	return True;
}

/**********************************************************************
 if it is a foreign SID or if the SID is in the free range, return true
**********************************************************************/

BOOL idmap_check_sid_is_in_free_range(const DOM_SID *sid)
{
	if (sid_compare_domain(get_global_sam_sid(), sid) == 0) {
	
		uint32 rid;

		if (sid_peek_rid(sid, &rid)) {
			return idmap_check_rid_is_in_free_range(rid);
		}

		return False;
	}

	return True;
}

/*****************************************************************
 Returns SID pointer.
*****************************************************************/  

NTSTATUS idmap_uid_to_sid(DOM_SID *sid, uid_t uid)
{
	unid_t id;
	int flags;

	DEBUG(10,("idmap_uid_to_sid: uid = [%d]\n", uid));

	flags = ID_USERID;
	id.uid = uid;
	
	return idmap_get_sid_from_id(sid, id, flags);
}

/*****************************************************************
 Group mapping is used for gids that maps to Wellknown SIDs
 Returns SID pointer.
*****************************************************************/  

NTSTATUS idmap_gid_to_sid(DOM_SID *sid, gid_t gid)
{
	unid_t id;
	int flags;

	DEBUG(10,("idmap_gid_to_sid: gid = [%d]\n", gid));

	flags = ID_GROUPID;
#if 0	/* JERRY */
	if (!idmap_check_ugid_is_in_free_range(gid)) {
		flags |= ID_QUERY_ONLY;
	}
#endif
	id.gid = gid;
	return idmap_get_sid_from_id(sid, id, flags);
}

/*****************************************************************
 if it is a foreign sid or it is in idmap rid range check idmap,
 otherwise falls back to the legacy algorithmic mapping.
 Returns True if this name is a user sid and the conversion
 was done correctly, False if not.
*****************************************************************/  

NTSTATUS idmap_sid_to_uid(const DOM_SID *sid, uid_t *uid, uint32 flags)
{
	NTSTATUS ret = NT_STATUS_UNSUCCESSFUL;
	unid_t id;

	DEBUG(10,("idmap_sid_to_uid: sid = [%s]\n", sid_string_static(sid)));

	flags |= ID_USERID;

	ret = idmap_get_id_from_sid(&id, &flags, sid);
	
	if ( NT_STATUS_IS_OK(ret) ) {
		DEBUG(10,("idmap_sid_to_uid: uid = [%d]\n", id.uid));
		*uid = id.uid;
	} 

	return ret;

}

/*****************************************************************
 *THE CANONICAL* convert SID to gid function.
 if it is a foreign sid or it is in idmap rid range check idmap,
 otherwise falls back to the legacy algorithmic mapping.
 Group mapping is used for gids that maps to Wellknown SIDs
 Returns True if this name is a user sid and the conversion
 was done correctly, False if not.
*****************************************************************/  

NTSTATUS idmap_sid_to_gid(const DOM_SID *sid, gid_t *gid, uint32 flags)
{
	NTSTATUS ret = NT_STATUS_UNSUCCESSFUL;
	unid_t id;

	DEBUG(10,("sid_to_gid: sid = [%s]\n", sid_string_static(sid)));

	flags |= ID_GROUPID;

	ret = idmap_get_id_from_sid(&id, &flags, sid);
	
	if ( NT_STATUS_IS_OK(ret) ) 
	{
		DEBUG(10,("idmap_sid_to_gid: gid = [%d]\n", id.gid));
		*gid = id.gid;
	}

	return ret;
}


/***************************************************************************
 Check first, call set_mapping if it doesn't already exist.
***************************************************************************/

static NTSTATUS wellknown_id_init(DOM_SID *sid, unid_t id, int flags)
{
	unid_t storedid;
	int qflags = flags | ID_QUERY_ONLY;

	if (!NT_STATUS_IS_OK(idmap_get_id_from_sid(&storedid, &qflags, sid))) {
		return idmap_set_mapping(sid, id, flags);
	} else {
		if (flags == ID_USERID && id.uid != storedid.uid) {
			DEBUG(0,("wellknown_id_init: WARNING ! Stored uid %u for SID %s is not the same as the requested uid %u\n",
				(unsigned int)storedid.uid, sid_string_static(sid), (unsigned int)id.uid ));
			DEBUG(0,("wellknown_id_init: Attempting to overwrite old mapping with new.\n"));
			return idmap_set_mapping(sid, id, flags);
		} else if (flags == ID_GROUPID && id.gid != storedid.gid) {
			DEBUG(0,("wellknown_id_init: WARNING ! Stored gid %u for SID %s is not the same as the requested gid %u\n",
				(unsigned int)storedid.gid, sid_string_static(sid), (unsigned int)id.gid ));
			DEBUG(0,("wellknown_id_init: Attempting to overwrite old mapping with new.\n"));
			return idmap_set_mapping(sid, id, flags);
		}
	}
	return NT_STATUS_OK;
}

/***************************************************************************
 Initialize idmap withWellknown SIDs like Guest, that are necessary
 to make samba run properly.
***************************************************************************/

BOOL idmap_init_wellknown_sids(void)
{
	const char *guest_account = lp_guestaccount();
	struct passwd *pass;
	GROUP_MAP *map=NULL;
	int num_entries=0;
	DOM_SID sid;
	unid_t id;
	fstring sid_string;

	if (!(guest_account && *guest_account)) {
		DEBUG(1, ("NULL guest account!?!?\n"));
		return False;
	}

	pass = getpwnam_alloc(guest_account);
	if (!pass) {
		return False;
	}

	/* Fill in the SID for the guest account. */
	id.uid = pass->pw_uid;
	sid_copy(&sid, get_global_sam_sid());
	sid_append_rid(&sid, DOMAIN_USER_RID_GUEST);

	if (!NT_STATUS_IS_OK(wellknown_id_init(&sid, id, ID_USERID))) {
		DEBUG(0, ("Failed to setup UID mapping for GUEST (%s) to (%u)\n", 
			  sid_to_string(sid_string, &sid), (unsigned int)id.uid));
		passwd_free(&pass);
		return False;
	}

	/* check if DOMAIN_GROUP_RID_GUESTS SID is set, if not store the
	 * guest account gid as mapping */
	id.gid = pass->pw_gid;
	sid_copy(&sid, get_global_sam_sid());
	sid_append_rid(&sid, DOMAIN_GROUP_RID_GUESTS);
	if (!NT_STATUS_IS_OK(wellknown_id_init(&sid, id, ID_GROUPID))) {
		DEBUG(0, ("Failed to setup GID mapping for Group DOMAIN GUESTS (%s) to (%u)\n", 
			  sid_to_string(sid_string, &sid), (unsigned int)id.gid));
		passwd_free(&pass);
		return False;
	}

	passwd_free(&pass);
	/* now fill in group mappings */
	if(pdb_enum_group_mapping(SID_NAME_UNKNOWN, &map, &num_entries, ENUM_ONLY_MAPPED)) {
		int i;

		for (i = 0; i < num_entries; i++) {
			id.gid = map[i].gid;
			wellknown_id_init(&map[i].sid, id, ID_GROUPID);
		}
		SAFE_FREE(map);
	}

	/* Fill in the SID for the administrator account. */
	id.uid = 0;
	sid_copy(&sid, get_global_sam_sid());
	sid_append_rid(&sid, DOMAIN_USER_RID_ADMIN);

	if (!NT_STATUS_IS_OK(wellknown_id_init(&sid, id, ID_USERID))) {
		DEBUG(0, ("Failed to setup UID mapping for ADMINISTRATOR (%s) to (%u)\n", 
			  sid_to_string(sid_string, &sid), (unsigned int)id.uid));
		return False;
	}

	return True;
}