@zerodensity/smb-cpp 0.0.0-bootstrap.0 → 0.1.0

package/win32_x64/third-party/libsmb2/source/include/smb2/libsmb2-raw.h

@@ -0,0 +1,497 @@
+/* -*-  mode:c; tab-width:8; c-basic-offset:8; indent-tabs-mode:nil;  -*- */
+/*
+   Copyright (C) 2016 by Ronnie Sahlberg <ronniesahlberg@gmail.com>
+
+   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.1 of the License, or
+   (at your option) any later version.
+
+   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 Lesser General Public License for more details.
+
+   You should have received a copy of the GNU Lesser General Public License
+   along with this program; if not, see <http://www.gnu.org/licenses/>.
+*/
+
+#ifndef _LIBSMB2_RAW_H_
+#define _LIBSMB2_RAW_H_
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/*
+ * Low level RAW SMB2 interface
+ */
+/*
+ * Magic file Id used for compound commands.
+ */
+extern const smb2_file_id compound_file_id;
+
+/*
+ * This function is used to free the data returned by the query functions.
+ */
+void smb2_free_data(struct smb2_context *smb2, void *ptr);
+
+/*
+ * Asynchronous SMB2 Negotiate
+ * pdu  : If the call was initiated and a connection will be attempted.
+ *        Result of the negotiate will be reported through the callback
+ *        function.
+ * NULL : If there was an error. The callback function will not be invoked.
+ *
+ * Returns:
+ *
+ * Callback parameters :
+ * status can be either of :
+ *    0     : Negotiate was successful.
+ *            Command_data is a struct smb2_negotiate_reply.
+ *
+ *   !0     : Status is NT status code. Command_data is NULL.
+ */
+struct smb2_pdu *smb2_cmd_negotiate_async(struct smb2_context *smb2,
+                                          struct smb2_negotiate_request *req,
+                                          smb2_command_cb cb, void *cb_data);
+
+
+struct smb2_pdu *smb2_cmd_negotiate_reply_async(struct smb2_context *smb2,
+                                          struct smb2_negotiate_reply *rep,
+                                          smb2_command_cb cb, void *cb_data);
+
+/*
+ * Asynchronous SMB2 Session Setup
+ *
+ * Returns:
+ * pdu  : If the call was initiated and a connection will be attempted.
+ *        Result of the session setup will be reported through the callback
+ *        function.
+ * NULL : If there was an error. The callback function will not be invoked.
+ *
+ * Callback parameters :
+ * status can be either of :
+ *    0     : Session setup was successful.
+ *            Command_data is a struct smb2_session_setup_reply.
+ *
+ *   !0     : Status is NT status code.
+ */
+struct smb2_pdu *smb2_cmd_session_setup_async(struct smb2_context *smb2,
+                                 struct smb2_session_setup_request *req,
+                                 smb2_command_cb cb, void *cb_data);
+
+struct smb2_pdu *smb2_cmd_session_setup_reply_async(struct smb2_context *smb2,
+                                struct smb2_session_setup_reply *rep,
+                                smb2_command_cb cb, void *cb_data);
+/*
+ * Asynchronous SMB2 Tree Connect
+ *
+ * Returns:
+ * pdu  : If the call was initiated and a connection will be attempted.
+ *        Result of the tree connect will be reported through the callback
+ *        function.
+ * NULL : If there was an error. The callback function will not be invoked.
+ *
+ * Callback parameters :
+ * status can be either of :
+ *    0     : Tree Connect was successful.
+ *            Command_data is a struct smb2_tree_connect_reply.
+ *
+ *   !0     : Status is NT status code. Command_data is NULL.
+ */
+struct smb2_pdu *smb2_cmd_tree_connect_async(struct smb2_context *smb2,
+                                struct smb2_tree_connect_request *req,
+                                smb2_command_cb cb, void *cb_data);
+
+struct smb2_pdu *smb2_cmd_tree_connect_reply_async(struct smb2_context *smb2,
+                            struct smb2_tree_connect_reply *rep,
+                            uint32_t tree_id,
+                            smb2_command_cb cb, void *cb_data);
+/*
+ * Asynchronous SMB2 Tree Disconnect
+ *
+ * Returns:
+ * pdu  : If the call was initiated and a connection will be attempted.
+ *        Result of the tree connect will be reported through the callback
+ *        function.
+ * NULL : If there was an error. The callback function will not be invoked.
+ *
+ * Callback parameters :
+ * status can be either of :
+ *    0     : Tree Disconnect was successful.
+ *
+ *   !0     : Status is NT status code.
+ *
+ * Command_data is always NULL.
+ */
+struct smb2_pdu *smb2_cmd_tree_disconnect_async(struct smb2_context *smb2,
+                                  smb2_command_cb cb, void *cb_data);
+
+struct smb2_pdu *smb2_cmd_tree_disconnect_reply_async(struct smb2_context *smb2,
+                                  smb2_command_cb cb, void *cb_data);
+
+/*
+ * Asynchronous SMB2 Create
+ *
+ * Returns:
+ * pdu  : If the call was initiated and a connection will be attempted.
+ *        Result of the create will be reported through the callback function.
+ * NULL : If there was an error. The callback function will not be invoked.
+ *
+ * Callback parameters :
+ * status can be either of :
+ *    0     : Create was successful.
+ *            Command_data is a struct smb2_create_reply.
+ *
+ *   !0     : Status is NT status code. Command_data is NULL.
+ */
+struct smb2_pdu *smb2_cmd_create_async(struct smb2_context *smb2,
+                                       struct smb2_create_request *req,
+                                       smb2_command_cb cb, void *cb_data);
+
+struct smb2_pdu *smb2_cmd_create_reply_async(struct smb2_context *smb2,
+                                       struct smb2_create_reply *rep,
+                                       smb2_command_cb cb, void *cb_data);
+
+/*
+ * Asynchronous SMB2 Close
+ *
+ * Returns:
+ * pdu  : If the call was initiated and a connection will be attempted.
+ *        Result of the close will be reported through the callback function.
+ * NULL : If there was an error. The callback function will not be invoked.
+ *
+ * Callback parameters :
+ * status can be either of :
+ *    0     : Close was successful.
+ *            Command_data is a struct smb2_close_reply.
+ *
+ *   !0     : Status is NT status code. Command_data is NULL.
+ */
+struct smb2_pdu *smb2_cmd_close_async(struct smb2_context *smb2,
+                                      struct smb2_close_request *req,
+                                      smb2_command_cb cb, void *cb_data);
+
+struct smb2_pdu *smb2_cmd_close_reply_async(struct smb2_context *smb2,
+                                      struct smb2_close_reply *rep,
+                                      smb2_command_cb cb, void *cb_data);
+
+/*
+ * Asynchronous SMB2 Read
+ *
+ * Returns:
+ * pdu  : If the call was initiated and a connection will be attempted.
+ *        Result of the read will be reported through the callback function.
+ * NULL : If there was an error. The callback function will not be invoked.
+ *
+ * Callback parameters :
+ * status can be either of :
+ *    0     : Read was successful.
+ *
+ *   !0     : Status is NT status code.
+ *
+ * command_data is always NULL.
+ */
+struct smb2_pdu *smb2_cmd_read_async(struct smb2_context *smb2,
+                                     struct smb2_read_request *req,
+                                     smb2_command_cb cb, void *cb_data);
+
+struct smb2_pdu *smb2_cmd_read_reply_async(struct smb2_context *smb2,
+                                     struct smb2_read_reply *rep,
+                                     smb2_command_cb cb, void *cb_data);
+
+/*
+ * Asynchronous SMB2 Write
+ *
+ * use pass_buf_ownerhip non-0 to allow the request's buf to be
+ * freed along with the pdu when it is freed, use 0 to retain
+ * req->buf
+ *
+ * Returns:
+ * pdu  : If the call was initiated and a connection will be attempted.
+ *        Result of the write will be reported through the callback function.
+ * NULL : If there was an error. The callback function will not be invoked.
+ *
+ * Callback parameters :
+ * status can be either of :
+ *    0     : Write was successful.
+ *
+ *   !0     : Status is NT status code.
+ *
+ * command_data is always NULL.
+ */
+struct smb2_pdu *smb2_cmd_write_async(struct smb2_context *smb2,
+                                      struct smb2_write_request *req,
+                                      int pass_buf_ownership,
+                                      smb2_command_cb cb, void *cb_data);
+
+struct smb2_pdu *smb2_cmd_write_reply_async(struct smb2_context *smb2,
+                                      struct smb2_write_reply *rep,
+                                      smb2_command_cb cb, void *cb_data);
+
+/*
+ * Asynchronous SMB2 Query Directory
+ *
+ * Returns:
+ * pdu  : If the call was initiated and a connection will be attempted.
+ *        Result of the QD will be reported through the callback function.
+ * NULL : If there was an error. The callback function will not be invoked.
+ *
+ * Callback parameters :
+ * status can be either of :
+ *    0     : Query was successful.
+ *            Command_data is a struct smb2_query_directory_reply.
+ *
+ *   !0     : Status is NT status code. Command_data is NULL.
+ */
+struct smb2_pdu *smb2_cmd_query_directory_async(struct smb2_context *smb2,
+                             struct smb2_query_directory_request *req,
+                             smb2_command_cb cb, void *cb_data);
+
+struct smb2_pdu *smb2_cmd_query_directory_reply_async(struct smb2_context *smb2,
+                             struct smb2_query_directory_request *req,
+                             struct smb2_query_directory_reply *rep,
+                             smb2_command_cb cb, void *cb_data);
+
+/*
+ * Asynchronous SMB2 Change Notify
+ *
+ * Returns:
+ * pdu  : If the call was initiated and a connection will be attempted.
+ *        Result of the close will be reported through the callback function.
+ * NULL : If there was an error. The callback function will not be invoked.
+ *
+ * Callback parameters :
+ * status can be either of :
+ *    0     : Close was successful.
+ *            Command_data is a struct smb2_close_reply.
+ *
+ *   !0     : Status is NT status code. Command_data is NULL.
+ */
+struct smb2_pdu *smb2_cmd_change_notify_async(struct smb2_context *smb2,
+                                      struct smb2_change_notify_request *req,
+                                      smb2_command_cb cb, void *cb_data);
+
+struct smb2_pdu *smb2_cmd_change_notify_reply_async(struct smb2_context *smb2,
+                                      struct smb2_change_notify_reply *rep,
+                                      smb2_command_cb cb, void *cb_data);
+
+/*
+ * Asynchronous SMB2 Query Info
+ *
+ * Returns:
+ * pdu  : If the call was initiated and a connection will be attempted.
+ *        Result of the QI will be reported through the callback function.
+ * NULL : If there was an error. The callback function will not be invoked.
+ *
+ * Callback parameters :
+ * status can be either of :
+ *    0     : Query was successful.
+ *            Command_data is a struct struct smb2_query_info_reply *
+ *            This structure contains a pointer to the requested data
+ *            structure in ->output_buffer.
+ *            Output_buffer must be freed by calling smb2_free_data()
+ *
+ *   !0     : Status is NT status code. Command_data is NULL.
+ */
+struct smb2_pdu *smb2_cmd_query_info_async(struct smb2_context *smb2,
+                                           struct smb2_query_info_request *req,
+                                           smb2_command_cb cb, void *cb_data);
+
+struct smb2_pdu *smb2_cmd_query_info_reply_async(struct smb2_context *smb2,
+                                           struct smb2_query_info_request *req,
+                                           struct smb2_query_info_reply *rep,
+                                           smb2_command_cb cb, void *cb_data);
+
+/*
+ * Asynchronous SMB2 Set Info
+ *
+ * Returns:
+ * pdu  : If the call was initiated and a connection will be attempted.
+ *        Result of the QI will be reported through the callback function.
+ * NULL : If there was an error. The callback function will not be invoked.
+ *
+ * Callback parameters :
+ * status can be either of :
+ *    0     : Query was successful.
+ *            Command_data is a struct struct smb2_query_info_reply *
+ *
+ *   !0     : Status is NT status code. Command_data is NULL.
+ */
+struct smb2_pdu *smb2_cmd_set_info_async(struct smb2_context *smb2,
+                                         struct smb2_set_info_request *req,
+                                         smb2_command_cb cb, void *cb_data);
+
+struct smb2_pdu *smb2_cmd_set_info_reply_async(struct smb2_context *smb2,
+                                         struct smb2_set_info_request *req,
+                                         smb2_command_cb cb, void *cb_data);
+
+/*
+ * Asynchronous SMB2 Ioctl
+ *
+ * Returns:
+ * pdu  : If the call was initiated and a connection will be attempted.
+ *        Result of the Ioctl will be reported through the callback function.
+ * NULL : If there was an error. The callback function will not be invoked.
+ *
+ * Callback parameters :
+ * status can be either of :
+ *    0     : Query was successful.
+ *            Command_data is a struct struct smb2_ioctl_reply *
+ *            This structure contains a pointer to the requested data
+ *            structure in ->output.
+ *            Output must be freed by calling smb2_free_data()
+ *
+ *   !0     : Status is NT status code. Command_data is NULL.
+ */
+struct smb2_pdu *smb2_cmd_ioctl_async(struct smb2_context *smb2,
+                                      struct smb2_ioctl_request *req,
+                                      smb2_command_cb cb, void *cb_data);
+
+struct smb2_pdu *smb2_cmd_ioctl_reply_async(struct smb2_context *smb2,
+                                      struct smb2_ioctl_reply *rep,
+                                      smb2_command_cb cb, void *cb_data);
+
+/*
+ * Asynchronous SMB2 Echo
+ *
+ * Returns:
+ * pdu  : If the call was initiated and a connection will be attempted.
+ *        Result of the echo will be reported through the callback function.
+ * NULL : If there was an error. The callback function will not be invoked.
+ *
+ * Callback parameters :
+ * status can be either of :
+ *    0     : Echo was successful.
+ *
+ *   !0     : Status is NT status code.
+ *
+ * command_data is always NULL.
+ */
+struct smb2_pdu *smb2_cmd_echo_async(struct smb2_context *smb2,
+                                     smb2_command_cb cb, void *cb_data);
+
+struct smb2_pdu *smb2_cmd_echo_reply_async(struct smb2_context *smb2,
+                                     smb2_command_cb cb, void *cb_data);
+
+/*
+ * Asynchronous SMB2 Lock
+ *
+ * Returns:
+ * pdu  : If the call was initiated and a connection will be attempted.
+ *        Result of the logoff will be reported through the callback function.
+ * NULL : If there was an error. The callback function will not be invoked.
+ *
+ * Callback parameters :
+ * status can be either of :
+ *    0     : Lock was successful.
+ *
+ *   !0     : Status is NT status code.
+ *
+ * command_data is always NULL.
+ */
+struct smb2_pdu *smb2_cmd_lock_async(struct smb2_context *smb2,
+                                       struct smb2_lock_request *req,
+                                       smb2_command_cb cb, void *cb_data);
+
+struct smb2_pdu *smb2_cmd_lock_reply_async(struct smb2_context *smb2,
+                                       smb2_command_cb cb, void *cb_data);
+
+/*
+ * Asynchronous SMB2 Logoff
+ *
+ * Returns:
+ * pdu  : If the call was initiated and a connection will be attempted.
+ *        Result of the logoff will be reported through the callback function.
+ * NULL : If there was an error. The callback function will not be invoked.
+ *
+ * Callback parameters :
+ * status can be either of :
+ *    0     : Logoff was successful.
+ *
+ *   !0     : Status is NT status code.
+ *
+ * command_data is always NULL.
+ */
+struct smb2_pdu *smb2_cmd_logoff_async(struct smb2_context *smb2,
+                                       smb2_command_cb cb, void *cb_data);
+
+struct smb2_pdu *smb2_cmd_logoff_reply_async(struct smb2_context *smb2,
+                                       smb2_command_cb cb, void *cb_data);
+
+/*
+ * Asynchronous SMB2 Flush
+ *
+ * Returns:
+ * pdu  : If the call was initiated and a connection will be attempted.
+ *        Result of the flush will be reported through the callback function.
+ * NULL : If there was an error. The callback function will not be invoked.
+ *
+ * Callback parameters :
+ * status can be either of :
+ *    0     : Flush was successful.
+ *
+ *   !0     : Status is NT status code.
+ *
+ * command_data is always NULL.
+ */
+struct smb2_pdu *smb2_cmd_flush_async(struct smb2_context *smb2,
+                                      struct smb2_flush_request *req,
+                                      smb2_command_cb cb, void *cb_data);
+
+struct smb2_pdu *smb2_cmd_flush_reply_async(struct smb2_context *smb2,
+                                      smb2_command_cb cb, void *cb_data);
+
+/*
+ * Asynchronous SMB2 oplock-break;
+ *
+ * Returns:
+ * pdu  : If the call was initiated and a connection will be attempted.
+ *        Result of the flush will be reported through the callback function.
+ * NULL : If there was an error. The callback function will not be invoked.
+ *
+ * Callback parameters :
+ * status can be either of :
+ *    0     : successful.
+ *
+ *   !0     : Status is NT status code.
+ *
+ * command_data is always NULL.
+ */
+struct smb2_pdu *smb2_cmd_oplock_break_async(struct smb2_context *smb2,
+                                      struct smb2_oplock_break_acknowledgement *req,
+                                      smb2_command_cb cb, void *cb_data);
+
+struct smb2_pdu *smb2_cmd_oplock_break_reply_async(struct smb2_context *smb2,
+                                      struct smb2_oplock_break_reply *rep,
+                                      smb2_command_cb cb, void *cb_data);
+
+struct smb2_pdu *smb2_cmd_oplock_break_notification_async(struct smb2_context *smb2,
+                                      struct smb2_oplock_break_notification *rep,
+                                      smb2_command_cb cb, void *cb_data);
+
+struct smb2_pdu *smb2_cmd_lease_break_async(struct smb2_context *smb2,
+                                      struct smb2_lease_break_acknowledgement *req,
+                                      smb2_command_cb cb, void *cb_data);
+
+struct smb2_pdu *smb2_cmd_lease_break_reply_async(struct smb2_context *smb2,
+                                      struct smb2_lease_break_reply *rep,
+                                      smb2_command_cb cb, void *cb_data);
+
+struct smb2_pdu *smb2_cmd_lease_break_notification_async(struct smb2_context *smb2,
+                                      struct smb2_lease_break_notification *req,
+                                      smb2_command_cb cb, void *cb_data);
+/*
+ *
+ */
+struct smb2_pdu *smb2_cmd_error_reply_async(struct smb2_context *smb2,
+                                      struct smb2_error_reply *rep,
+                                      uint8_t causing_command,
+                                      int status,
+                                      smb2_command_cb cb, void *cb_data);
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* !_LIBSMB2_RAW_H_ */