initial commit

This commit is contained in:
Grant Limberg
2023-08-24 12:51:00 -07:00
commit 3925bce762
4 changed files with 482 additions and 0 deletions
+160
View File
@@ -0,0 +1,160 @@
Mozilla Public License
Version 2.0
1. Definitions
1.1. “Contributor”
means each individual or legal entity that creates, contributes to the creation of, or owns Covered Software.
1.2. “Contributor Version”
means the combination of the Contributions of others (if any) used by a Contributor and that particular Contributors Contribution.
1.3. “Contribution”
means Covered Software of a particular Contributor.
1.4. “Covered Software”
means Source Code Form to which the initial Contributor has attached the notice in Exhibit A, the Executable Form of such Source Code Form, and Modifications of such Source Code Form, in each case including portions thereof.
1.5. “Incompatible With Secondary Licenses”
means
that the initial Contributor has attached the notice described in Exhibit B to the Covered Software; or
that the Covered Software was made available under the terms of version 1.1 or earlier of the License, but not also under the terms of a Secondary License.
1.6. “Executable Form”
means any form of the work other than Source Code Form.
1.7. “Larger Work”
means a work that combines Covered Software with other material, in a separate file or files, that is not Covered Software.
1.8. “License”
means this document.
1.9. “Licensable”
means having the right to grant, to the maximum extent possible, whether at the time of the initial grant or subsequently, any and all of the rights conveyed by this License.
1.10. “Modifications”
means any of the following:
any file in Source Code Form that results from an addition to, deletion from, or modification of the contents of Covered Software; or
any new file in Source Code Form that contains any Covered Software.
1.11. “Patent Claims” of a Contributor
means any patent claim(s), including without limitation, method, process, and apparatus claims, in any patent Licensable by such Contributor that would be infringed, but for the grant of the License, by the making, using, selling, offering for sale, having made, import, or transfer of either its Contributions or its Contributor Version.
1.12. “Secondary License”
means either the GNU General Public License, Version 2.0, the GNU Lesser General Public License, Version 2.1, the GNU Affero General Public License, Version 3.0, or any later versions of those licenses.
1.13. “Source Code Form”
means the form of the work preferred for making modifications.
1.14. “You” (or “Your”)
means an individual or a legal entity exercising rights under this License. For legal entities, “You” includes any entity that controls, is controlled by, or is under common control with You. For purposes of this definition, “control” means (a) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (b) ownership of more than fifty percent (50%) of the outstanding shares or beneficial ownership of such entity.
2. License Grants and Conditions
2.1. Grants
Each Contributor hereby grants You a world-wide, royalty-free, non-exclusive license:
under intellectual property rights (other than patent or trademark) Licensable by such Contributor to use, reproduce, make available, modify, display, perform, distribute, and otherwise exploit its Contributions, either on an unmodified basis, with Modifications, or as part of a Larger Work; and
under Patent Claims of such Contributor to make, use, sell, offer for sale, have made, import, and otherwise transfer either its Contributions or its Contributor Version.
2.2. Effective Date
The licenses granted in Section 2.1 with respect to any Contribution become effective for each Contribution on the date the Contributor first distributes such Contribution.
2.3. Limitations on Grant Scope
The licenses granted in this Section 2 are the only rights granted under this License. No additional rights or licenses will be implied from the distribution or licensing of Covered Software under this License. Notwithstanding Section 2.1(b) above, no patent license is granted by a Contributor:
for any code that a Contributor has removed from Covered Software; or
for infringements caused by: (i) Your and any other third partys modifications of Covered Software, or (ii) the combination of its Contributions with other software (except as part of its Contributor Version); or
under Patent Claims infringed by Covered Software in the absence of its Contributions.
This License does not grant any rights in the trademarks, service marks, or logos of any Contributor (except as may be necessary to comply with the notice requirements in Section 3.4).
2.4. Subsequent Licenses
No Contributor makes additional grants as a result of Your choice to distribute the Covered Software under a subsequent version of this License (see Section 10.2) or under the terms of a Secondary License (if permitted under the terms of Section 3.3).
2.5. Representation
Each Contributor represents that the Contributor believes its Contributions are its original creation(s) or it has sufficient rights to grant the rights to its Contributions conveyed by this License.
2.6. Fair Use
This License is not intended to limit any rights You have under applicable copyright doctrines of fair use, fair dealing, or other equivalents.
2.7. Conditions
Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in Section 2.1.
3. Responsibilities
3.1. Distribution of Source Form
All distribution of Covered Software in Source Code Form, including any Modifications that You create or to which You contribute, must be under the terms of this License. You must inform recipients that the Source Code Form of the Covered Software is governed by the terms of this License, and how they can obtain a copy of this License. You may not attempt to alter or restrict the recipients rights in the Source Code Form.
3.2. Distribution of Executable Form
If You distribute Covered Software in Executable Form then:
such Covered Software must also be made available in Source Code Form, as described in Section 3.1, and You must inform recipients of the Executable Form how they can obtain a copy of such Source Code Form by reasonable means in a timely manner, at a charge no more than the cost of distribution to the recipient; and
You may distribute such Executable Form under the terms of this License, or sublicense it under different terms, provided that the license for the Executable Form does not attempt to limit or alter the recipients rights in the Source Code Form under this License.
3.3. Distribution of a Larger Work
You may create and distribute a Larger Work under terms of Your choice, provided that You also comply with the requirements of this License for the Covered Software. If the Larger Work is a combination of Covered Software with a work governed by one or more Secondary Licenses, and the Covered Software is not Incompatible With Secondary Licenses, this License permits You to additionally distribute such Covered Software under the terms of such Secondary License(s), so that the recipient of the Larger Work may, at their option, further distribute the Covered Software under the terms of either this License or such Secondary License(s).
3.4. Notices
You may not remove or alter the substance of any license notices (including copyright notices, patent notices, disclaimers of warranty, or limitations of liability) contained within the Source Code Form of the Covered Software, except that You may alter any license notices to the extent required to remedy known factual inaccuracies.
3.5. Application of Additional Terms
You may choose to offer, and to charge a fee for, warranty, support, indemnity or liability obligations to one or more recipients of Covered Software. However, You may do so only on Your own behalf, and not on behalf of any Contributor. You must make it absolutely clear that any such warranty, support, indemnity, or liability obligation is offered by You alone, and You hereby agree to indemnify every Contributor for any liability incurred by such Contributor as a result of warranty, support, indemnity or liability terms You offer. You may include additional disclaimers of warranty and limitations of liability specific to any jurisdiction.
4. Inability to Comply Due to Statute or Regulation
If it is impossible for You to comply with any of the terms of this License with respect to some or all of the Covered Software due to statute, judicial order, or regulation then You must: (a) comply with the terms of this License to the maximum extent possible; and (b) describe the limitations and the code they affect. Such description must be placed in a text file included with all distributions of the Covered Software under this License. Except to the extent prohibited by statute or regulation, such description must be sufficiently detailed for a recipient of ordinary skill to be able to understand it.
5. Termination
5.1. The rights granted under this License will terminate automatically if You fail to comply with any of its terms. However, if You become compliant, then the rights granted under this License from a particular Contributor are reinstated (a) provisionally, unless and until such Contributor explicitly and finally terminates Your grants, and (b) on an ongoing basis, if such Contributor fails to notify You of the non-compliance by some reasonable means prior to 60 days after You have come back into compliance. Moreover, Your grants from a particular Contributor are reinstated on an ongoing basis if such Contributor notifies You of the non-compliance by some reasonable means, this is the first time You have received notice of non-compliance with this License from such Contributor, and You become compliant prior to 30 days after Your receipt of the notice.
5.2. If You initiate litigation against any entity by asserting a patent infringement claim (excluding declaratory judgment actions, counter-claims, and cross-claims) alleging that a Contributor Version directly or indirectly infringes any patent, then the rights granted to You by any and all Contributors for the Covered Software under Section 2.1 of this License shall terminate.
5.3. In the event of termination under Sections 5.1 or 5.2 above, all end user license agreements (excluding distributors and resellers) which have been validly granted by You or Your distributors under this License prior to termination shall survive termination.
6. Disclaimer of Warranty
Covered Software is provided under this License on an “as is” basis, without warranty of any kind, either expressed, implied, or statutory, including, without limitation, warranties that the Covered Software is free of defects, merchantable, fit for a particular purpose or non-infringing. The entire risk as to the quality and performance of the Covered Software is with You. Should any Covered Software prove defective in any respect, You (not any Contributor) assume the cost of any necessary servicing, repair, or correction. This disclaimer of warranty constitutes an essential part of this License. No use of any Covered Software is authorized under this License except under this disclaimer.
7. Limitation of Liability
Under no circumstances and under no legal theory, whether tort (including negligence), contract, or otherwise, shall any Contributor, or anyone who distributes Covered Software as permitted above, be liable to You for any direct, indirect, special, incidental, or consequential damages of any character including, without limitation, damages for lost profits, loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses, even if such party shall have been informed of the possibility of such damages. This limitation of liability shall not apply to liability for death or personal injury resulting from such partys negligence to the extent applicable law prohibits such limitation. Some jurisdictions do not allow the exclusion or limitation of incidental or consequential damages, so this exclusion and limitation may not apply to You.
8. Litigation
Any litigation relating to this License may be brought only in the courts of a jurisdiction where the defendant maintains its principal place of business and such litigation shall be governed by laws of that jurisdiction, without reference to its conflict-of-law provisions. Nothing in this Section shall prevent a partys ability to bring cross-claims or counter-claims.
9. Miscellaneous
This License represents the complete agreement concerning the subject matter hereof. If any provision of this License is held to be unenforceable, such provision shall be reformed only to the extent necessary to make it enforceable. Any law or regulation which provides that the language of a contract shall be construed against the drafter shall not be used to construe this License against a Contributor.
10. Versions of the License
10.1. New Versions
Mozilla Foundation is the license steward. Except as provided in Section 10.3, no one other than the license steward has the right to modify or publish new versions of this License. Each version will be given a distinguishing version number.
10.2. Effect of New Versions
You may distribute the Covered Software under the terms of the version of the License under which You originally received the Covered Software, or under the terms of any subsequent version published by the license steward.
10.3. Modified Versions
If you create software not governed by this License, and you want to create a new license for such software, you may create and use a modified version of this License if you rename the license and remove any references to the name of the license steward (except to note that such modified license differs from this License).
10.4. Distributing Source Code Form that is Incompatible With Secondary Licenses
If You choose to distribute Source Code Form that is Incompatible With Secondary Licenses under the terms of this version of the License, the notice described in Exhibit B of this License must be attached.
Exhibit A - Source Code Form License Notice
This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at https://mozilla.org/MPL/2.0/.
If it is not possible or desirable to put the notice in a particular file, then You may include the notice in a location (such as a LICENSE file in a relevant directory) where a recipient would be likely to look for such a notice.
You may add additional accurate notices of copyright ownership.
Exhibit B - “Incompatible With Secondary Licenses” Notice
This Source Code Form is “Incompatible With Secondary Licenses”, as defined by the Mozilla Public License, v. 2.0.
+9
View File
@@ -0,0 +1,9 @@
# ZTC Hooks
`ztchooks` provides primitives for serializing and verifying hooks fired from [ZeroTier Central](https://my.zerotier.com)
As of publishing time, this package is still a work in progress and the webhooks from ZeroTier Central are not publicly available yet.
# License
Copyright 2023 ZeroTier, Inc. All rights reserved. Licensed under the Mozilla Public License Version 2.0. See the `LICENSE` file for the full license text.
+3
View File
@@ -0,0 +1,3 @@
module github.com/zerotier/ztchooks
go 1.18
+310
View File
@@ -0,0 +1,310 @@
// Copyright 2023 ZeroTier, Inc. All rights reserved.
// Use of this source code is governed by the Mozilla Public License Version 2.0
// license that can be found in the LICENSE file.
// Package ztchooks provides primitives for serializing and verifying hooks
// fired from [ZeroTier Central](https://my.zerotier.com)
package ztchooks
type HookType string
// HooKTypes
const (
HOOK_TYPE_UNKNOWN HookType = "UNKNOWN"
NETWORK_JOIN HookType = "NETWORK_JOIN"
NETWORK_AUTH HookType = "NETWORK_AUTH"
NETWORK_DEAUTH HookType = "NETWORK_DEAUTH"
NETWORK_SSO_LOGIN HookType = "NETWORK_SSO_LOGIN"
NETWORK_SSO_LOGIN_ERROR HookType = "NETWORK_SSO_LOGIN_ERROR"
NETWORK_CREATED HookType = "NETWORK_CREATED"
NETWORK_CONFIG_CHANGED HookType = "NETWORK_CONFIG_CHANGED"
NETWORK_DELETED HookType = "NETWORK_DELETED"
MEMBER_CONFIG_CHANGED HookType = "MEMBER_CONFIG_CHANGED"
MEMBER_DELETED HookType = "MEMBER_DELETED"
ORG_INVITE_SENT HookType = "ORG_INVITE_SENT"
ORG_INVITE_ACCEPTED HookType = "ORG_INVITE_ACCEPTED"
ORG_INVITE_REJECTED HookType = "ORG_INVITE_REJECTED"
ORG_MEMBER_REMOVED HookType = "ORG_MEMBER_REMOVED"
)
// HookTypeFromString is a convenience function to convert from a string
// to a HookType value
func HookTypeFromString(hType string) HookType {
switch hType {
case string(NETWORK_JOIN):
return NETWORK_JOIN
case string(NETWORK_AUTH):
return NETWORK_AUTH
case string(NETWORK_DEAUTH):
return NETWORK_DEAUTH
case string(NETWORK_SSO_LOGIN):
return NETWORK_SSO_LOGIN
case string(NETWORK_SSO_LOGIN_ERROR):
return NETWORK_SSO_LOGIN_ERROR
case string(NETWORK_CREATED):
return NETWORK_CREATED
case string(NETWORK_CONFIG_CHANGED):
return NETWORK_CONFIG_CHANGED
case string(NETWORK_DELETED):
return NETWORK_DELETED
case string(MEMBER_CONFIG_CHANGED):
return MEMBER_CONFIG_CHANGED
case string(MEMBER_DELETED):
return MEMBER_DELETED
case string(ORG_INVITE_SENT):
return ORG_INVITE_SENT
case string(ORG_INVITE_ACCEPTED):
return ORG_INVITE_ACCEPTED
case string(ORG_INVITE_REJECTED):
return ORG_INVITE_REJECTED
case string(ORG_MEMBER_REMOVED):
return ORG_MEMBER_REMOVED
default:
return HOOK_TYPE_UNKNOWN
}
}
// HookTypeToString is a convenience function to convert from HookType
// to a string
func HookTypeToString(hType HookType) string {
return string(hType)
}
// HookBase contains the base information present in all webhooks sent by
// ZeroTier Central
type HookBase struct {
// HookID is the internal ZeroTier Central ID of the hook being fired
HookID string `json:"hook_id"`
// OrgID is the internal Organization ID the hook belongs to
OrgID string `json:"org_id"`
// HookType is the type of hook being fired.
HookType HookType `json:"hook_type"`
}
// NewMemberJoined is fired for `NETWORK_JOIN` hooks. This hook is fired
// the first time the controller sees a new member attempting to join
// a ZeroTier network
type NewMemberJoined struct {
HookBase
// NetworkID is the network a new member has joined
NetworkID string `json:"network_id"`
// MemberID is the member that is attempting to join the network.
MemberID string `json:"member_id"`
}
// NetworkMemberAuth is fired for `NETWORK_AUTH` events
type NetworkMemberAuth struct {
HookBase
// NetworkID is the network that the member was authorized to join
NetworkID string `json:"network_id"`
// MemberID is the member authorized to join the network
MemberID string `json:"member_id"`
// UserID is the user that performed the authorization
UserID string `json:"user_id"`
// UserEmail is the email address of the user performing the authorization
UserEmail string `json:"user_email"`
}
// NetworkMemberDeauth is fired for `NETWORK_DEAUTH` events
type NetworkMemberDeauth struct {
HookBase
// NetworkID is the network that new member was deauthorized from
NetworkID string `json:"network_id"`
// MemberID is the member deauthorized from accessing the network
MemberID string `json:"member_id"`
// UserID is the user that performed the deauthorization
UserID string `json:"user_id"`
// UserEmail is the email address of the user performing the deauthorization
UserEmail string `json:"user_email"`
}
// NetworkSSOLogin is fired whenever a user logs into a network via a configured
// OIDC provider
type NetworkSSOLogin struct {
HookBase
// NetworkID is the network on which the SSO login was performed
NetworkID string `json:"network_id"`
// MemberID is the network member ID on which the SSO login was performed
MemberID string `json:"member_id"`
// SSOUserEmail is the email address of the user logging into the network
SSOUserEmail string `json:"sso_user_email"`
}
// NetworkSSOLoginError is fired when there is a failure during the SSO login process
type NetworkSSOLoginError struct {
HookBase
// NetworkID is the network on which the SSO login attempt was performed
NetworkID string `json:"network_id"`
// MemberID is the network member ID on which the SSO login attempt was performed
MemberID string `json:"member_id"`
// SSOUserEmail is the email address of the user attempting to login into the network
SSOUserEmail string `json:"sso_user_email"`
// Error is a description of the error
Error string `json:"error"`
}
// NetworkCreated is fired whenever an organization member creates a new network
type NetworkCreated struct {
HookBase
// NetworkID is the ID of the newly created network
NetworkID string `json:"network_id"`
// NetworkConfig is the initial configuration of the new network
NetworkConfig map[string]any `json:"network_config"`
// UserID is the ID of the user creating the network
UserID string `json:"user_id"`
// UserEmail is the email address of the user creating the network
UserEmail string `json:"user_email"`
}
// NetworkConfigChanged is fired whenever the configuration of a ZeroTier network changes
type NetworkConfigChanged struct {
HookBase
// NetworkID is the network on which the SSO login attempt was performed
NetworkID string `json:"network_id"`
// UserID is the user that performed the network configuration change
UserID string `json:"user_id"`
// UserEmail is the email address of the user that performed the network configuration change
UserEmail string `json:"user_email"`
// OldConfig is the network configuration before the change was applied
OldConfig map[string]any `json:"old_config"`
// NewConfig is the new configuration for the network.
NewConfig map[string]any `json:"new_config"`
}
// NetworkDeleted is fired whenever a network configuration is changed
type NetworkDeleted struct {
HookBase
// NetworkID is the network that was deleted
NetworkID string `json:"network_id"`
// OldConfig is the network configuration before the network was deleted
OldConfig map[string]any `json:"old_config"`
// UserID is the ID of the user that deleted the network
UserID string `json:"user_id"`
// UserEmail is the email address of the user that deleted the network
UserEmail string `json:"user_email"`
}
// MemberConfigChanged is fired when a network member's configuration changes
type MemberConfigChanged struct {
HookBase
// NetworkID is the network the member was joined to
NetworkID string `json:"network_id"`
// MemberID is the network member that was changed
MemberID string `json:"member_id"`
// OldConfig is the network member configuration prior to the change
OldConfig map[string]any `json:"old_config"`
// NewConfig is the newly applied member configuration
NewConfig map[string]any `json:"new_config"`
// UserID is the ID of the user that modified the network member
UserID string `json:"user_id"`
// UserEmail is the email address of the user that modified the network member
UserEmail string `json:"user_email"`
}
type MemberDeleted struct {
HookBase
// NetworkID is the network the member was joined to
NetworkID string `json:"network_id"`
// MemberID is the network member that was deleted
MemberID string `json:"member_id"`
// OldConfig is the network member configuration prior to the deletion
OldConfig map[string]any `json:"old_config"`
// UserID is the ID of the user that deleted the network member
UserID string `json:"user_id"`
// UserEmail is the email address of the user that deleted the network member
UserEmail string `json:"user_email"`
}
// OrgInviteSent is fired whenever a new member is invited to join your ZeroTer organization
// in ZeroTier Central. Because only the org owner can add or remove people from the org,
// the ID of the person performing the invite is omitted.
type OrgInviteSent struct {
HookBase
// UserID is the user sending the invite
UserID string `json:"user_id"`
// InviteeEmail is the email address of the invitee
InviteeEmail string `json:"invitee_email"`
}
// OrgInviteAccepted is fired when a user accepts the invitation to join your organization
type OrgInviteAccepted struct {
HookBase
// UserID is the user ID accepting the invite
UserID string `json:"user_id"`
// UserEmail is the email address of the user accepting the invite
UserEmail string `json:"user_email"`
// NetworkIDs
NetworkIDs []string `json:"network_ids"`
}
// OrgInviteRejected is fired when a user rejects the invite to the organization
type OrgInviteRejected struct {
HookBase
// UserID is the user ID rejecting the invite
UserID string `json:"user_id"`
// UserEmail is the email address of the user rejecting the invite
UserEmail string `json:"user_email"`
}
// OrgMemberRemoved is fired whenever an organization member is removed.
// Since currently only the org owner can add or remove people from the org,
// the ID of the person performing the removal is omitted.
type OrgMemberRemoved struct {
HookBase
// UserID is the user ID removed from the organization
UserID string `json:"user_id"`
// UserEmail is the email address of the user removed from the organization
UserEmail string `json:"user_email"`
}