File: cmd_set_channel_security_keys.go

package info (click to toggle)
golang-github-bougou-go-ipmi 0.7.8-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,880 kB
  • sloc: makefile: 38
file content (118 lines) | stat: -rw-r--r-- 3,002 bytes parent folder | download
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
package ipmi

import (
	"context"
	"fmt"
)

// 22.25 Set Channel Security Keys Command
type SetChannelSecurityKeysRequest struct {
	ChannelNumber uint8

	Operation ChannelSecurityKeysOperation

	KeyID uint8

	KeyValue []byte
}

type ChannelSecurityKeysOperation uint8

const (
	ChannelSecurityKeysOperationRead ChannelSecurityKeysOperation = 0
	ChannelSecurityKeysOperationSet  ChannelSecurityKeysOperation = 1
	ChannelSecurityKeysOperationLock ChannelSecurityKeysOperation = 2
)

func (operation ChannelSecurityKeysOperation) String() string {
	m := map[ChannelSecurityKeysOperation]string{
		ChannelSecurityKeysOperationRead: "read",
		ChannelSecurityKeysOperationSet:  "set",
		ChannelSecurityKeysOperationLock: "lock",
	}
	s, ok := m[operation]
	if ok {
		return s
	}
	return "Unknown"
}

type ChannelSecurityKeysLockStatus uint8

const (
	ChannelSecurityKeysLockStatus_NotLockable ChannelSecurityKeysLockStatus = 0
	ChannelSecurityKeysLockStatus_Locked      ChannelSecurityKeysLockStatus = 1
	ChannelSecurityKeysLockStatus_Unlocked    ChannelSecurityKeysLockStatus = 2
)

func (lockStatus ChannelSecurityKeysLockStatus) String() string {
	m := map[ChannelSecurityKeysLockStatus]string{
		ChannelSecurityKeysLockStatus_NotLockable: "not lockable",
		ChannelSecurityKeysLockStatus_Locked:      "locked",
		ChannelSecurityKeysLockStatus_Unlocked:    "unlocked",
	}
	s, ok := m[lockStatus]
	if ok {
		return s
	}
	return "Unknown"
}

type SetChannelSecurityKeysResponse struct {
	LockStatus ChannelSecurityKeysLockStatus
	KeyValue   []byte
}

func (req *SetChannelSecurityKeysRequest) Pack() []byte {
	out := make([]byte, 3+len(req.KeyValue))

	out[0] = req.ChannelNumber
	out[1] = byte(req.Operation)
	out[2] = req.KeyID

	if len(req.KeyValue) > 0 {
		packBytes(req.KeyValue, out, 3)
	}

	return out
}

func (req *SetChannelSecurityKeysRequest) Command() Command {
	return CommandSetChannelSecurityKeys
}

func (res *SetChannelSecurityKeysResponse) CompletionCodes() map[uint8]string {
	return map[uint8]string{
		0x80: "Cannot perform set / confirm. Key is locked",
		0x81: "insufficient key bytes",
		0x82: "too many key bytes",
		0x83: "key value does not meet criteria for specified type of key",
		0x84: "KR is not used.",
	}
}

func (res *SetChannelSecurityKeysResponse) Unpack(msg []byte) error {
	if len(msg) < 1 {
		return ErrUnpackedDataTooShortWith(len(msg), 1)
	}

	res.LockStatus = ChannelSecurityKeysLockStatus(msg[0])

	if len(msg) > 1 {
		res.KeyValue, _, _ = unpackBytes(msg, 1, len(msg)-1)
	}

	return nil
}

func (res *SetChannelSecurityKeysResponse) Format() string {
	return "" +
		fmt.Sprintf("Lock Status : %s (%d)\n", res.LockStatus.String(), uint8(res.LockStatus)) +
		fmt.Sprintf("Key Value   : %v\n", res.KeyValue)
}

func (c *Client) SetChannelSecurityKeys(ctx context.Context, request *SetChannelSecurityKeysRequest) (response *SetChannelSecurityKeysResponse, err error) {
	response = &SetChannelSecurityKeysResponse{}
	err = c.Exchange(ctx, request, response)
	return
}