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
|
/*
* Copyright (c) 2015, 2025, Oracle and/or its affiliates.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License, version 2.0,
* as published by the Free Software Foundation.
*
* This program is designed to work with certain software (including
* but not limited to OpenSSL) that is licensed under separate terms,
* as designated in a particular file or component or in included license
* documentation. The authors of MySQL hereby grant you an additional
* permission to link the program and your derivative works with the
* separately licensed software that they have either included with
* the program or referenced in the documentation.
*
* 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, version 2.0, 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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
syntax = "proto2";
import "mysqlx.proto"; // comment_out_if PROTOBUF_LITE
// ifdef PROTOBUF_LITE: option optimize_for = LITE_RUNTIME;
/**
@namespace Mysqlx::Session
@brief Messages to manage sessions.
@startuml "Messages for Sessions"
== session start ==
Client -> Server: AuthenticateStart
opt
Server --> Client: AuthenticateContinue
Client --> Server: AuthenticateContinue
end
alt
Server --> Client: AuthenticateOk
else
Server --> Client: Error
end
...
== session reset ==
Client -> Server: Reset
Server --> Client: Ok
== session end ==
Client -> Server: Close
Server --> Client: Ok
@enduml
*/
package Mysqlx.Session;
option java_package = "com.mysql.cj.x.protobuf";
/**
The initial message send from the client to the server to start
the authentication process.
@returns @ref Mysqlx::Session::AuthenticateContinue
*/
message AuthenticateStart {
/** authentication mechanism name */
required string mech_name = 1;
/** authentication data */
optional bytes auth_data = 2;
/** initial response */
optional bytes initial_response = 3;
option (client_message_id) = SESS_AUTHENTICATE_START; // comment_out_if PROTOBUF_LITE
}
/**
Send by client or server after an @ref Mysqlx::Session::AuthenticateStart
to exchange more authentication data.
@returns Mysqlx::Session::AuthenticateContinue
*/
message AuthenticateContinue {
/** authentication data */
required bytes auth_data = 1;
option (server_message_id) = SESS_AUTHENTICATE_CONTINUE; // comment_out_if PROTOBUF_LITE
option (client_message_id) = SESS_AUTHENTICATE_CONTINUE; // comment_out_if PROTOBUF_LITE
}
/**
Sent by the server after successful authentication.
*/
message AuthenticateOk {
/** authentication data */
optional bytes auth_data = 1;
option (server_message_id) = SESS_AUTHENTICATE_OK; // comment_out_if PROTOBUF_LITE
}
/**
Reset the current session.
@returns @ref Mysqlx::Ok
*/
message Reset {
/** if is true the session will be reset, but stays authenticated; otherwise,
the session will be closed and needs to be authenticated again */
optional bool keep_open = 1 [ default = false ];
option (client_message_id) = SESS_RESET; // comment_out_if PROTOBUF_LITE
}
/**
Close the current session.
@returns @ref Mysqlx::Ok
*/
message Close {
option (client_message_id) = SESS_CLOSE; // comment_out_if PROTOBUF_LITE
}
|
