lib/pb-protocol: Add PB_PROTOCOL_ACTION_AUTHENTICATE
[petitboot] / lib / pb-protocol / pb-protocol.h
1 #ifndef _PB_PROTOCOL_H
2 #define _PB_PROTOCOL_H
3
4 #include <stdint.h>
5 #include <stdio.h>
6
7 #include <list/list.h>
8 #include <types/types.h>
9
10 #define PB_SOCKET_PATH "/tmp/petitboot.ui"
11
12 #define PB_PROTOCOL_MAX_PAYLOAD_SIZE (64 * 1024)
13
14 enum pb_protocol_action {
15         PB_PROTOCOL_ACTION_DEVICE_ADD           = 0x1,
16         PB_PROTOCOL_ACTION_BOOT_OPTION_ADD      = 0x2,
17         PB_PROTOCOL_ACTION_DEVICE_REMOVE        = 0x3,
18 /*      PB_PROTOCOL_ACTION_BOOT_OPTION_REMOVE   = 0x4, */
19         PB_PROTOCOL_ACTION_BOOT                 = 0x5,
20         PB_PROTOCOL_ACTION_STATUS               = 0x6,
21         PB_PROTOCOL_ACTION_CANCEL_DEFAULT       = 0x7,
22         PB_PROTOCOL_ACTION_SYSTEM_INFO          = 0x8,
23         PB_PROTOCOL_ACTION_CONFIG               = 0x9,
24         PB_PROTOCOL_ACTION_REINIT               = 0xa,
25         PB_PROTOCOL_ACTION_ADD_URL              = 0xb,
26         PB_PROTOCOL_ACTION_PLUGIN_OPTION_ADD    = 0xc,
27         PB_PROTOCOL_ACTION_PLUGINS_REMOVE       = 0xd,
28         PB_PROTOCOL_ACTION_PLUGIN_INSTALL       = 0xe,
29         PB_PROTOCOL_ACTION_TEMP_AUTOBOOT        = 0xf,
30         PB_PROTOCOL_ACTION_AUTHENTICATE         = 0x10,
31 };
32
33 struct pb_protocol_message {
34         uint32_t action;
35         uint32_t payload_len;
36         char     payload[];
37 };
38
39 enum auth_msg_type {
40         AUTH_MSG_REQUEST,
41         AUTH_MSG_RESPONSE,
42         AUTH_MSG_SET,
43 };
44
45 struct auth_message {
46         enum auth_msg_type op;
47         union {
48                 bool    authenticated;
49                 char    *password;
50                 struct {
51                         char    *password;
52                         char    *new_password;
53                 } set_password;
54         };
55 };
56
57 void pb_protocol_dump_device(const struct device *dev, const char *text,
58         FILE *stream);
59 int pb_protocol_device_len(const struct device *dev);
60 int pb_protocol_boot_option_len(const struct boot_option *opt);
61 int pb_protocol_boot_len(const struct boot_command *boot);
62 int pb_protocol_boot_status_len(const struct status *status);
63 int pb_protocol_system_info_len(const struct system_info *sysinfo);
64 int pb_protocol_config_len(const struct config *config);
65 int pb_protocol_url_len(const char *url);
66 int pb_protocol_plugin_option_len(const struct plugin_option *opt);
67 int pb_protocol_temp_autoboot_len(const struct autoboot_option *opt);
68 int pb_protocol_authenticate_len(struct auth_message *msg);
69 int pb_protocol_device_cmp(const struct device *a, const struct device *b);
70
71 int pb_protocol_boot_option_cmp(const struct boot_option *a,
72         const struct boot_option *b);
73
74 int pb_protocol_serialise_string(char *pos, const char *str);
75 char *pb_protocol_deserialise_string(void *ctx,
76                 const struct pb_protocol_message *message);
77
78 int pb_protocol_serialise_device(const struct device *dev,
79                 char *buf, int buf_len);
80 int pb_protocol_serialise_boot_option(const struct boot_option *opt,
81                 char *buf, int buf_len);
82 int pb_protocol_serialise_boot_command(const struct boot_command *boot,
83                 char *buf, int buf_len);
84 int pb_protocol_serialise_boot_status(const struct status *status,
85                 char *buf, int buf_len);
86 int pb_protocol_serialise_system_info(const struct system_info *sysinfo,
87                 char *buf, int buf_len);
88 int pb_protocol_serialise_config(const struct config *config,
89                 char *buf, int buf_len);
90 int pb_protocol_serialise_url(const char *url, char *buf, int buf_len);
91 int pb_protocol_serialise_plugin_option(const struct plugin_option *opt,
92                 char *buf, int buf_len);
93 int pb_protocol_serialise_temp_autoboot(const struct autoboot_option *opt,
94                 char *buf, int buf_len);
95 int pb_protocol_serialise_authenticate(struct auth_message *msg,
96                 char *buf, int buf_len);
97
98 int pb_protocol_write_message(int fd, struct pb_protocol_message *message);
99
100 struct pb_protocol_message *pb_protocol_create_message(void *ctx,
101                 enum pb_protocol_action action, int payload_len);
102
103 struct pb_protocol_message *pb_protocol_read_message(void *ctx, int fd);
104
105 int pb_protocol_deserialise_device(struct device *dev,
106                 const struct pb_protocol_message *message);
107
108 int pb_protocol_deserialise_boot_option(struct boot_option *opt,
109                 const struct pb_protocol_message *message);
110
111 int pb_protocol_deserialise_boot_command(struct boot_command *cmd,
112                 const struct pb_protocol_message *message);
113
114 int pb_protocol_deserialise_boot_status(struct status *status,
115                 const struct pb_protocol_message *message);
116
117 int pb_protocol_deserialise_system_info(struct system_info *sysinfo,
118                 const struct pb_protocol_message *message);
119
120 int pb_protocol_deserialise_config(struct config *config,
121                 const struct pb_protocol_message *message);
122
123 int pb_protocol_deserialise_plugin_option(struct plugin_option *opt,
124                 const struct pb_protocol_message *message);
125
126 int pb_protocol_deserialise_temp_autoboot(struct autoboot_option *opt,
127                 const struct pb_protocol_message *message);
128
129 int pb_protocol_deserialise_authenticate(struct auth_message *msg,
130                 const struct pb_protocol_message *message);
131 #endif /* _PB_PROTOCOL_H */