/usr/include/OpenIPMI/ipmi_auth.h is in libopenipmi-dev 2.0.18-0ubuntu3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 | /*
* ipmi_auth.h
*
* MontaVista IPMI interface for authorization
*
* Author: MontaVista Software, Inc.
* Corey Minyard <minyard@mvista.com>
* source@mvista.com
*
* Copyright 2002,2003,2004,2005 MontaVista Software Inc.
*
* This software is available to you under a choice of one of two
* licenses. You may choose to be licensed under the terms of the GNU
* Lesser General Public License (GPL) Version 2 or the modified BSD
* license below. The following disclamer applies to both licenses:
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
* TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
* USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* GNU Lesser General Public Licence
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation; either version 2 of
* the License, or (at your option) any later version.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this program; if not, write to the Free
* Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*
* Modified BSD Licence
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided
* with the distribution.
* 3. The name of the author may not be used to endorse or promote
* products derived from this software without specific prior
* written permission.
*/
#ifndef _IPMI_AUTH_H
#define _IPMI_AUTH_H
#ifdef __cplusplus
extern "C" {
#endif
/* Data is provided to the authorization code as an array of these items, a
"scatter-gather" list. The algorithm will go through the item in the
array until "data" is NULL. */
typedef struct ipmi_auth_sg_s
{
void *data; /* NULL to terminate. */
int len;
} ipmi_auth_sg_t;
/* A handle for an authorization algorithm to use. */
typedef struct ipmi_authdata_s *ipmi_authdata_t;
typedef struct ipmi_auth_s
{
/* Initialize the authorization engine and return a handle for it.
You must pass this handle into the other authorization
calls. Return 0 on success or an errno on failure. */
int (*authcode_init)(unsigned char *password,
ipmi_authdata_t *handle,
void *info,
void *(*mem_alloc)(void *info, int size),
void (*mem_free)(void *info, void *data));
/* Generate a 16-byte authorization code and put it into
"output". Returns 0 on success and an errno on failure. */
int (*authcode_gen)(ipmi_authdata_t handle,
ipmi_auth_sg_t data[],
void *output);
/* Check that the 16-byte authorization code given in "code" is valid.
This will return 0 if it is valid or EINVAL if not. */
int (*authcode_check)(ipmi_authdata_t handle,
ipmi_auth_sg_t data[],
void *code);
/* Free the handle. You MUST call this when you are done with the
handle. */
void (*authcode_cleanup)(ipmi_authdata_t handle);
} ipmi_auth_t;
#define IPMI_USERNAME_MAX 16
#define IPMI_PASSWORD_MAX 20
/* Standard IPMI authentication algorithms. */
#define IPMI_AUTHTYPE_DEFAULT (~0) /* Choose the most secure available */
#define IPMI_AUTHTYPE_NONE 0
#define IPMI_AUTHTYPE_MD2 1
#define IPMI_AUTHTYPE_MD5 2
#define IPMI_AUTHTYPE_STRAIGHT 4
#define IPMI_AUTHTYPE_OEM 5
#define IPMI_AUTHTYPE_RMCP_PLUS 6
const char *ipmi_authtype_string(int authtype);
/* This is a table of authentication algorithms. */
#define MAX_IPMI_AUTHS 6
extern ipmi_auth_t ipmi_auths[MAX_IPMI_AUTHS];
/* IPMI privilege levels */
#define IPMI_PRIVILEGE_CALLBACK 1
#define IPMI_PRIVILEGE_USER 2
#define IPMI_PRIVILEGE_OPERATOR 3
#define IPMI_PRIVILEGE_ADMIN 4
#define IPMI_PRIVILEGE_OEM 5
const char *ipmi_privilege_string(int privilege);
/* Tell if a specific command is permitted for the given priviledge
level. Returns one of the following. */
#define IPMI_PRIV_INVALID -1
#define IPMI_PRIV_DENIED 0
#define IPMI_PRIV_PERMITTED 1
#define IPMI_PRIV_SEND 2 /* Special send message handling needed. */
#define IPMI_PRIV_BOOT 3 /* Special set system boot options handling.*/
int ipmi_cmd_permitted(unsigned char priv,
unsigned char netfn,
unsigned char cmd);
#ifdef __cplusplus
}
#endif
#endif /* _IPMI_AUTH_H */
|