--- /dev/null
+/*
+ * Copyright (c) 2014, 2015 Apple Inc. All rights reserved.
+ *
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
+ *
+ * This file contains Original Code and/or Modifications of Original Code
+ * as defined in and that are subject to the Apple Public Source License
+ * Version 2.0 (the 'License'). You may not use this file except in
+ * compliance with the License. The rights granted to you under the License
+ * may not be used to create, or enable the creation or redistribution of,
+ * unlawful or unlicensed copies of an Apple operating system, or to
+ * circumvent, violate, or enable the circumvention or violation of, any
+ * terms of an Apple operating system software license agreement.
+ *
+ * Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this file.
+ *
+ * The Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
+ * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
+ * limitations under the License.
+ *
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
+ */
+
+#ifndef _NETAGENT_H_
+#define _NETAGENT_H_
+
+#include <netinet/in.h>
+#include <sys/socket.h>
+
+#ifdef BSD_KERNEL_PRIVATE
+#include <stdbool.h>
+
+errno_t netagent_init(void);
+#endif
+#ifdef PRIVATE
+/*
+ * Name registered by the Network Agent kernel control
+ */
+#define NETAGENT_CONTROL_NAME "com.apple.net.netagent"
+
+struct netagent_message_header {
+ u_int8_t message_type;
+ u_int8_t message_flags;
+ u_int32_t message_id;
+ u_int32_t message_error;
+ u_int32_t message_payload_length;
+};
+
+struct netagent_trigger_message {
+ u_int32_t trigger_flags;
+ pid_t trigger_pid;
+ uuid_t trigger_proc_uuid;
+};
+
+#define NETAGENT_MESSAGE_TYPE_REGISTER 1 // Pass netagent to set, no return value
+#define NETAGENT_MESSAGE_TYPE_UNREGISTER 2 // No value, no return value
+#define NETAGENT_MESSAGE_TYPE_UPDATE 3 // Pass netagent to update, no return value
+#define NETAGENT_MESSAGE_TYPE_GET 4 // No value, return netagent
+#define NETAGENT_MESSAGE_TYPE_TRIGGER 5 // Kernel initiated, no reply expected
+#define NETAGENT_MESSAGE_TYPE_ASSERT 6 // Pass uuid of netagent to assert
+#define NETAGENT_MESSAGE_TYPE_UNASSERT 7 // Pass uuid of netagent to unassert
+#define NETAGENT_MESSAGE_TYPE_TRIGGER_ASSERT 8 // Kernel initiated, no reply expected
+#define NETAGENT_MESSAGE_TYPE_TRIGGER_UNASSERT 9 // Kernel initiated, no reply expected
+
+#define NETAGENT_MESSAGE_FLAGS_RESPONSE 0x01 // Used for acks, errors, and query responses
+
+#define NETAGENT_MESSAGE_ERROR_NONE 0
+#define NETAGENT_MESSAGE_ERROR_INTERNAL 1
+#define NETAGENT_MESSAGE_ERROR_UNKNOWN_TYPE 2
+#define NETAGENT_MESSAGE_ERROR_INVALID_DATA 3
+#define NETAGENT_MESSAGE_ERROR_NOT_REGISTERED 4
+#define NETAGENT_MESSAGE_ERROR_ALREADY_REGISTERED 5
+#define NETAGENT_MESSAGE_ERROR_CANNOT_UPDATE 6
+
+#define NETAGENT_DOMAINSIZE 32
+#define NETAGENT_TYPESIZE 32
+#define NETAGENT_DESCSIZE 128
+
+#define NETAGENT_MAX_DATA_SIZE 1024
+
+#define NETAGENT_FLAG_REGISTERED 0x0001 // Agent is registered
+#define NETAGENT_FLAG_ACTIVE 0x0002 // Agent is active
+#define NETAGENT_FLAG_KERNEL_ACTIVATED 0x0004 // Agent can be activated by kernel activity
+#define NETAGENT_FLAG_USER_ACTIVATED 0x0008 // Agent can be activated by system call (netagent_trigger)
+#define NETAGENT_FLAG_VOLUNTARY 0x0010 // Use of agent is optional
+#define NETAGENT_FLAG_SPECIFIC_USE_ONLY 0x0020 // Agent should only be used and activated when specifically required
+
+#define NETAGENT_TRIGGER_FLAG_USER 0x0001 // Userspace triggered agent
+#define NETAGENT_TRIGGER_FLAG_KERNEL 0x0002 // Kernel triggered agent
+
+#define KEV_NETAGENT_SUBCLASS 9
+#define KEV_NETAGENT_REGISTERED 1
+#define KEV_NETAGENT_UNREGISTERED 2
+#define KEV_NETAGENT_UPDATED 3
+#define KEV_NETAGENT_UPDATED_INTERFACES 4
+
+struct kev_netagent_data {
+ uuid_t netagent_uuid;
+};
+
+// To be used with kernel control socket
+struct netagent {
+ uuid_t netagent_uuid;
+ char netagent_domain[NETAGENT_DOMAINSIZE];
+ char netagent_type[NETAGENT_TYPESIZE];
+ char netagent_desc[NETAGENT_DESCSIZE];
+ u_int32_t netagent_flags;
+ u_int32_t netagent_data_size;
+ u_int8_t netagent_data[0];
+};
+
+// To be used with SIOCGAGENTDATA
+struct netagent_req {
+ uuid_t netagent_uuid;
+ char netagent_domain[NETAGENT_DOMAINSIZE];
+ char netagent_type[NETAGENT_TYPESIZE];
+ char netagent_desc[NETAGENT_DESCSIZE];
+ u_int32_t netagent_flags;
+ u_int32_t netagent_data_size;
+ u_int8_t *netagent_data;
+};
+#ifdef BSD_KERNEL_PRIVATE
+int netagent_ioctl(u_long cmd, caddr_t data);
+
+struct netagent_req32 {
+ uuid_t netagent_uuid;
+ char netagent_domain[NETAGENT_DOMAINSIZE];
+ char netagent_type[NETAGENT_TYPESIZE];
+ char netagent_desc[NETAGENT_DESCSIZE];
+ u_int32_t netagent_flags;
+ u_int32_t netagent_data_size;
+ user32_addr_t netagent_data;
+};
+struct netagent_req64 {
+ uuid_t netagent_uuid;
+ char netagent_domain[NETAGENT_DOMAINSIZE];
+ char netagent_type[NETAGENT_TYPESIZE];
+ char netagent_desc[NETAGENT_DESCSIZE];
+ u_int32_t netagent_flags;
+ u_int32_t netagent_data_size;
+ user64_addr_t netagent_data __attribute__((aligned(8)));
+};
+
+// Kernel accessors
+void netagent_post_updated_interfaces(uuid_t uuid); // To be called from interface ioctls
+
+u_int32_t netagent_get_flags(uuid_t uuid);
+
+int netagent_kernel_trigger(uuid_t uuid);
+#endif /* BSD_KERNEL_PRIVATE */
+
+#endif /* PRIVATE */
+
+#ifndef KERNEL
+int netagent_trigger(uuid_t agent_uuid, size_t agent_uuidlen);
+#endif /* !KERNEL */
+
+#endif /* _NETAGENT_H_ */
projects / apple / xnu.git / blobdiff