usr/src/lib/libipmi/common/ipmi_user.c
changeset 5345 44060de1d838
child 5621 cd0984d5b1c1
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/usr/src/lib/libipmi/common/ipmi_user.c	Fri Oct 26 13:47:19 2007 -0700
@@ -0,0 +1,339 @@
+/*
+ * CDDL HEADER START
+ *
+ * The contents of this file are subject to the terms of the
+ * Common Development and Distribution License (the "License").
+ * You may not use this file except in compliance with the License.
+ *
+ * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
+ * or http://www.opensolaris.org/os/licensing.
+ * See the License for the specific language governing permissions
+ * and limitations under the License.
+ *
+ * When distributing Covered Code, include this CDDL HEADER in each
+ * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
+ * If applicable, add the following below this CDDL HEADER, with the
+ * fields enclosed by brackets "[]" replaced with your own identifying
+ * information: Portions Copyright [yyyy] [name of copyright owner]
+ *
+ * CDDL HEADER END
+ */
+/*
+ * Copyright 2007 Sun Microsystems, Inc.  All rights reserved.
+ * Use is subject to license terms.
+ */
+
+#pragma ident	"%Z%%M%	%I%	%E% SMI"
+
+#include <libipmi.h>
+#include <string.h>
+
+#include "ipmi_impl.h"
+
+/*
+ * Get User Access.  See section 22.27.
+ *
+ * See libipmi.h for a complete description of IPMI reference material.
+ */
+
+typedef struct ipmi_get_user_access_req {
+#if defined(_BIT_FIELDS_LTOH)
+	uint8_t		igua_channel:4;
+	uint8_t		__reserved1:4;
+	uint8_t		igua_uid:2;
+	uint8_t		__reserved2:6;
+#else
+	uint8_t		__reserved1:4;
+	uint8_t		igua_channel:4;
+	uint8_t		__reserved2:2;
+	uint8_t		igua_uid:6;
+#endif
+} ipmi_get_user_access_req_t;
+
+#define	IPMI_CMD_GET_USER_ACCESS	0x44
+
+typedef struct ipmi_get_user_access {
+#if defined(_BIT_FIELDS_LTOH)
+	uint8_t		igua_max_uid:4;
+	uint8_t		__reserved1:4;
+	uint8_t		igua_enable_status:4;
+	uint8_t		igua_enabled_uid:4;
+	uint8_t		__reserved2:4;
+	uint8_t		igua_fixed_uid:4;
+	uint8_t		__reserved3:1;
+	uint8_t		igua_only_callback:1;
+	uint8_t		igua_link_auth_enable:1;
+	uint8_t		igua_ipmi_msg_enable:1;
+	uint8_t		igua_privilege_level:4;
+#else
+	uint8_t		__reserved1:4;
+	uint8_t		igua_max_uid:4;
+	uint8_t		igua_enabled_uid:4;
+	uint8_t		igua_enable_status:4;
+	uint8_t		igua_fixed_uid:4;
+	uint8_t		__reserved2:4;
+	uint8_t		igua_privilege_level:4;
+	uint8_t		igua_ipmi_msg_enable:1;
+	uint8_t		igua_link_auth_enable:1;
+	uint8_t		igua_only_callback:1;
+	uint8_t		__reserved3:1;
+#endif
+} ipmi_get_user_access_t;
+
+#define	IPMI_USER_ENABLE_UNSPECIFIED	0x00
+#define	IPMI_USER_ENABLE_SETPASSWD	0x01
+#define	IPMI_USER_DISABLE_SETPASSWD	0x02
+
+#define	IPMI_USER_CHANNEL_CURRENT	0xe
+
+/*
+ * Get User Name.  See section 22.29
+ */
+
+#define	IPMI_CMD_GET_USER_NAME		0x46
+
+/*
+ * Set User Password.  See section 22.30
+ */
+
+#define	IPMI_CMD_SET_USER_PASSWORD	0x47
+
+typedef struct ipmi_set_user_password {
+#if defined(_BIT_FIELDS_LTOH)
+	uint8_t		isup_uid:6;
+	uint8_t		__reserved1:1;
+	uint8_t		isup_len20:1;
+	uint8_t		isup_op:2;
+	uint8_t		__reserved2:6;
+#else
+	uint8_t		isup_len20:1;
+	uint8_t		__reserved1:1;
+	uint8_t		isup_uid:6;
+	uint8_t		__reserved2:6;
+	uint8_t		isup_op:2;
+#endif
+	char		isup_passwd[20];
+} ipmi_set_user_password_t;
+
+#define	IPMI_PASSWORD_OP_DISABLE	0x0
+#define	IPMI_PASSWORD_OP_ENABLE		0x1
+#define	IPMI_PASSWORD_OP_SET		0x2
+#define	IPMI_PASSWORD_OP_TEST		0x3
+
+static ipmi_get_user_access_t *
+ipmi_get_user_access(ipmi_handle_t *ihp, uint8_t channel, uint8_t uid)
+{
+	ipmi_cmd_t cmd, *resp;
+	ipmi_get_user_access_req_t req = { 0 };
+
+	req.igua_channel = channel;
+	req.igua_uid = uid;
+
+	cmd.ic_netfn = IPMI_NETFN_APP;
+	cmd.ic_cmd = IPMI_CMD_GET_USER_ACCESS;
+	cmd.ic_lun = 0;
+	cmd.ic_data = &req;
+	cmd.ic_dlen = sizeof (req);
+
+	if ((resp = ipmi_send(ihp, &cmd)) == NULL) {
+		/*
+		 * If sessions aren't supported on the current channel, some
+		 * service processors (notably Sun's ILOM) will return an
+		 * invalid request completion code (0xCC).  For these SPs, we
+		 * translate this to the more appropriate EIPMI_INVALID_COMMAND.
+		 */
+		if (ipmi_errno(ihp) == EIPMI_INVALID_REQUEST)
+			(void) ipmi_set_error(ihp, EIPMI_INVALID_COMMAND,
+			    NULL);
+		return (NULL);
+	}
+
+	if (resp->ic_dlen < sizeof (ipmi_get_user_access_t)) {
+		(void) ipmi_set_error(ihp, EIPMI_BAD_RESPONSE_LENGTH, NULL);
+		return (NULL);
+	}
+
+	return (resp->ic_data);
+}
+
+static const char *
+ipmi_get_user_name(ipmi_handle_t *ihp, uint8_t uid)
+{
+	ipmi_cmd_t cmd, *resp;
+
+	cmd.ic_netfn = IPMI_NETFN_APP;
+	cmd.ic_cmd = IPMI_CMD_GET_USER_ACCESS;
+	cmd.ic_lun = 0;
+	cmd.ic_data = &uid;
+	cmd.ic_dlen = sizeof (uid);
+
+	if ((resp = ipmi_send(ihp, &cmd)) == NULL)
+		return (NULL);
+
+	if (resp->ic_dlen < 16) {
+		(void) ipmi_set_error(ihp, EIPMI_BAD_RESPONSE_LENGTH, NULL);
+		return (NULL);
+	}
+
+	return (resp->ic_data);
+}
+
+void
+ipmi_user_clear(ipmi_handle_t *ihp)
+{
+	ipmi_user_t *up, *next;
+
+	while ((up = ihp->ih_users) != NULL) {
+		next = up->iu_next;
+		ipmi_free(ihp, up->iu_name);
+		ipmi_free(ihp, up);
+		ihp->ih_users = next;
+	}
+}
+
+/*
+ * Returns user information in a well-defined structure.
+ */
+int
+ipmi_user_iter(ipmi_handle_t *ihp, int (*func)(ipmi_user_t *, void *),
+    void *data)
+{
+	ipmi_get_user_access_t *resp;
+	uint8_t i;
+	ipmi_user_t *up;
+	const char *name;
+
+	ipmi_user_clear(ihp);
+
+	/*
+	 * First get the number of active users on the system by requesting the
+	 * reserved user ID (0).
+	 */
+	if ((resp = ipmi_get_user_access(ihp,
+	    IPMI_USER_CHANNEL_CURRENT, 0)) == NULL)
+		return (-1);
+
+	for (i = 1; i <= resp->igua_max_uid; i++) {
+		if ((resp = ipmi_get_user_access(ihp,
+		    IPMI_USER_CHANNEL_CURRENT, i)) == NULL)
+			return (-1);
+
+		if ((up = ipmi_zalloc(ihp, sizeof (ipmi_user_t))) == NULL)
+			return (-1);
+
+		up->iu_enabled = resp->igua_enabled_uid;
+		up->iu_uid = i;
+		up->iu_ipmi_msg_enable = resp->igua_ipmi_msg_enable;
+		up->iu_link_auth_enable = resp->igua_link_auth_enable;
+		up->iu_priv = resp->igua_privilege_level;
+		up->iu_next = ihp->ih_users;
+		ihp->ih_users = up;
+
+		if ((name = ipmi_get_user_name(ihp, i)) == NULL)
+			return (-1);
+
+		if (*name != '\0' &&
+		    (up->iu_name = ipmi_strdup(ihp, name)) == NULL)
+			return (-1);
+	}
+
+	for (up = ihp->ih_users; up != NULL; up = up->iu_next) {
+		if (func(up, data) != 0)
+			return (-1);
+	}
+
+	return (0);
+}
+
+typedef struct ipmi_user_cb {
+	const char	*uic_name;
+	uint8_t		uic_uid;
+	ipmi_user_t	*uic_result;
+} ipmi_user_cb_t;
+
+static int
+ipmi_user_callback(ipmi_user_t *up, void *data)
+{
+	ipmi_user_cb_t *cbp = data;
+
+	if (cbp->uic_result != NULL)
+		return (0);
+
+	if (up->iu_name) {
+		if (strcmp(up->iu_name, cbp->uic_name) == 0)
+			cbp->uic_result = up;
+	} else if (up->iu_uid == cbp->uic_uid) {
+		cbp->uic_result = up;
+	}
+
+	return (0);
+}
+
+ipmi_user_t *
+ipmi_user_lookup_name(ipmi_handle_t *ihp, const char *name)
+{
+	ipmi_user_cb_t cb = { 0 };
+
+	cb.uic_name = name;
+	cb.uic_result = NULL;
+
+	if (ipmi_user_iter(ihp, ipmi_user_callback, &cb) != 0)
+		return (NULL);
+
+	if (cb.uic_result == NULL)
+		(void) ipmi_set_error(ihp, EIPMI_NOT_PRESENT,
+		    "no such user");
+
+	return (cb.uic_result);
+}
+
+ipmi_user_t *
+ipmi_user_lookup_id(ipmi_handle_t *ihp, uint8_t uid)
+{
+	ipmi_user_cb_t cb = { 0 };
+
+	cb.uic_uid = uid;
+	cb.uic_result = NULL;
+
+	if (ipmi_user_iter(ihp, ipmi_user_callback, &cb) != 0)
+		return (NULL);
+
+	if (cb.uic_result == NULL)
+		(void) ipmi_set_error(ihp, EIPMI_NOT_PRESENT,
+		    "no such user");
+
+	return (cb.uic_result);
+}
+
+int
+ipmi_user_set_password(ipmi_handle_t *ihp, uint8_t uid, const char *passwd)
+{
+	ipmi_set_user_password_t req = { 0 };
+	ipmi_cmd_t cmd;
+
+	req.isup_uid = uid;
+	req.isup_op = IPMI_PASSWORD_OP_SET;
+
+	if (strlen(passwd) > 19)
+		return (ipmi_set_error(ihp, EIPMI_INVALID_REQUEST,
+		    "password length must be less than 20 characters"));
+
+	if (strlen(passwd) > 15)
+		req.isup_len20 = 1;
+
+	(void) strcpy(req.isup_passwd, passwd);
+
+	cmd.ic_netfn = IPMI_NETFN_APP;
+	cmd.ic_cmd = IPMI_CMD_SET_USER_PASSWORD;
+	cmd.ic_lun = 0;
+	cmd.ic_data = &req;
+	if (req.isup_len20)
+		cmd.ic_dlen = sizeof (req);
+	else
+		cmd.ic_dlen = sizeof (req) - 4;
+
+	if (ipmi_send(ihp, &cmd) == NULL)
+		return (-1);
+
+	return (0);
+}