abusemesh

type AbuseDetectionMethod struct {
	// Types that are valid to be assigned to DetectionMethod:
	//	*AbuseDetectionMethod_UnstandardizedDetectionMethod
	//	*AbuseDetectionMethod_DetectionMethodType
	DetectionMethod isAbuseDetectionMethod_DetectionMethod `protobuf_oneof:"detection_method"`
}

type AbuseDetectionMethodType int32

type AbuseDetectionMethod_DetectionMethodType struct {
	DetectionMethodType AbuseDetectionMethodType `protobuf:"varint,2,opt,name=detection_method_type,json=detectionMethodType,enum=abusemesh.AbuseDetectionMethodType,oneof"`
}

type AbuseDetectionMethod_UnstandardizedDetectionMethod struct {
	UnstandardizedDetectionMethod string `protobuf:"bytes,1,opt,name=unstandardized_detection_method,json=unstandardizedDetectionMethod,oneof"`
}

type AbuseMeshClient interface {
	// Returns the Node data of the current node
	GetNode(ctx context.Context, in *GetNodeRequest, opts ...grpc.CallOption) (*Node, error)
	// With this call a client offers a signature of the identity to the server
	// This allows the server to increase its credibility
	OfferSignature(ctx context.Context, in *OfferSignatureRequest, opts ...grpc.CallOption) (*OfferSignatureResponse, error)
	// This call can be used by a client to request to a neighbor of this node
	NegotiateNeighborship(ctx context.Context, in *NegotiateNeighborshipRequest, opts ...grpc.CallOption) (*NegotiateNeighborshipResponse, error)
	// Opens a stream on which all table events of a node are published
	TableEventStream(ctx context.Context, in *TableEventStreamRequest, opts ...grpc.CallOption) (AbuseMesh_TableEventStreamClient, error)
}

type AbuseMeshServer interface {
	// Returns the Node data of the current node
	GetNode(context.Context, *GetNodeRequest) (*Node, error)
	// With this call a client offers a signature of the identity to the server
	// This allows the server to increase its credibility
	OfferSignature(context.Context, *OfferSignatureRequest) (*OfferSignatureResponse, error)
	// This call can be used by a client to request to a neighbor of this node
	NegotiateNeighborship(context.Context, *NegotiateNeighborshipRequest) (*NegotiateNeighborshipResponse, error)
	// Opens a stream on which all table events of a node are published
	TableEventStream(*TableEventStreamRequest, AbuseMesh_TableEventStreamServer) error
}

type AbuseMesh_TableEventStreamClient interface {
	Recv() (*TableEvent, error)
	grpc.ClientStream
}

type AbuseMesh_TableEventStreamServer interface {
	Send(*TableEvent) error
	grpc.ServerStream
}

type AbuseType int32

type ContactDetails struct {
	OrganizationName string                   `protobuf:"bytes,1,opt,name=organization_name,json=organizationName" json:"organization_name,omitempty"`
	EmailAddress     string                   `protobuf:"bytes,2,opt,name=email_address,json=emailAddress" json:"email_address,omitempty"`
	PhoneNumber      string                   `protobuf:"bytes,3,opt,name=phone_number,json=phoneNumber" json:"phone_number,omitempty"`
	PhysicalAddress  string                   `protobuf:"bytes,4,opt,name=physical_address,json=physicalAddress" json:"physical_address,omitempty"`
	ContactPersons   []*ContactDetails_Person `protobuf:"bytes,5,rep,name=contact_persons,json=contactPersons" json:"contact_persons,omitempty"`
}

type ContactDetails_Person struct {
	FirstName    string `protobuf:"bytes,6,opt,name=first_name,json=firstName" json:"first_name,omitempty"`
	MiddleName   string `protobuf:"bytes,7,opt,name=middle_name,json=middleName" json:"middle_name,omitempty"`
	LastName     string `protobuf:"bytes,8,opt,name=last_name,json=lastName" json:"last_name,omitempty"`
	JobTitle     string `protobuf:"bytes,9,opt,name=job_title,json=jobTitle" json:"job_title,omitempty"`
	EmailAddress string `protobuf:"bytes,10,opt,name=email_address,json=emailAddress" json:"email_address,omitempty"`
	PhoneNumber  string `protobuf:"bytes,11,opt,name=phone_number,json=phoneNumber" json:"phone_number,omitempty"`
}

type DelistAcceptance struct {
	// The id of the delist acceptance
	Uuid *UUID `protobuf:"bytes,1,opt,name=uuid" json:"uuid,omitempty"`
	// The id of the delist request
	DelistRequest *UUID `protobuf:"bytes,2,opt,name=delist_request,json=delistRequest" json:"delist_request,omitempty"`
	// The node which accepted the delisting request
	Node *Node `protobuf:"bytes,3,opt,name=node" json:"node,omitempty"`
	// The signature that proves the node it the author of the delist acceptance and that the delist acceptance has not been modified
	Signature *PGPSignature `protobuf:"bytes,4,opt,name=signature" json:"signature,omitempty"`
	// A human readable description which may explain why the delist request was accepted
	Description string `protobuf:"bytes,5,opt,name=description" json:"description,omitempty"`
	// A key value map of evidence which proves a report is incorrect or resolved
	// e.g. http request and response to a url which now returns a 404 in case of copyright infringement
	Evidence map[string]*Evidence `` /* 136-byte string literal not displayed */
	// The method which was used to accept this method
	// e.g. manual(human check)
	// e.g. automated copyright check tool
	AcceptanceMethod *DelistAcceptanceMethod `protobuf:"bytes,7,opt,name=acceptance_method,json=acceptanceMethod" json:"acceptance_method,omitempty"`
	// A map containing extra details about the acceptance method
	// e.g. what is the name, version and source code of a scanner
	// e.g. Which human checked the delist request
	// TODO maybe this should be standardized as well at some point
	AcceptanceMethodMetadata map[string]string `` /* 202-byte string literal not displayed */
}

type DelistAcceptanceMethod struct {
	// Types that are valid to be assigned to AcceptanceMethod:
	//	*DelistAcceptanceMethod_UnstandardizedAcceptanceMethodType
	//	*DelistAcceptanceMethod_MethodType
	AcceptanceMethod isDelistAcceptanceMethod_AcceptanceMethod `protobuf_oneof:"acceptance_method"`
}

type DelistAcceptanceMethodType int32

type DelistAcceptanceMethod_MethodType struct {
	MethodType DelistAcceptanceMethodType `protobuf:"varint,2,opt,name=method_type,json=methodType,enum=abusemesh.DelistAcceptanceMethodType,oneof"`
}

type DelistAcceptanceMethod_UnstandardizedAcceptanceMethodType struct {
	UnstandardizedAcceptanceMethodType string `protobuf:"bytes,1,opt,name=unstandardized_acceptance_method_type,json=unstandardizedAcceptanceMethodType,oneof"`
}

type DelistRequest struct {
	// The id of the delist request
	Uuid *UUID `protobuf:"bytes,1,opt,name=uuid" json:"uuid,omitempty"`
	// The report to be delisted
	Report *UUID `protobuf:"bytes,2,opt,name=report" json:"report,omitempty"`
	// The node which requested the delisting
	Node *Node `protobuf:"bytes,3,opt,name=node" json:"node,omitempty"`
	// The signature that proves the requester it the author of the delist request and that the delist request has not been modified
	Signature *PGPSignature `protobuf:"bytes,4,opt,name=signature" json:"signature,omitempty"`
	// A human readable description which may explain why a report is incorrect or has been resolved
	Description string `protobuf:"bytes,5,opt,name=description" json:"description,omitempty"`
	// A key value map of evidence which proves a report is incorrect or resolved
	// e.g. a letter of consent when appealing a scanning abuse report
	// e.g. a link to a court case
	Evidence map[string]*Evidence `` /* 136-byte string literal not displayed */
	// A map containing extra details
	// e.g. when reporting a DOS attack the type of DOS attack can be a metadata field
	// TODO maybe this should be standardized as well at some point
	Metadata map[string]string `` /* 136-byte string literal not displayed */
}

type Evidence struct {
	// Types that are valid to be assigned to EvidenceType:
	//	*Evidence_UnstandardizedEvidenceType
	//	*Evidence_Type
	EvidenceType isEvidence_EvidenceType `protobuf_oneof:"evidence_type"`
	EvidenceData []byte                  `protobuf:"bytes,3,opt,name=evidence_data,json=evidenceData,proto3" json:"evidence_data,omitempty"`
}

type EvidenceType int32

type Evidence_Type struct {
	Type EvidenceType `protobuf:"varint,2,opt,name=type,enum=abusemesh.EvidenceType,oneof"`
}

type Evidence_UnstandardizedEvidenceType struct {
	UnstandardizedEvidenceType string `protobuf:"bytes,1,opt,name=unstandardized_evidence_type,json=unstandardizedEvidenceType,oneof"`
}

type GetNodeRequest struct {
}

type IPAddress struct {
	AddressFamily IPAddressFamily `protobuf:"varint,1,opt,name=address_family,json=addressFamily,enum=abusemesh.IPAddressFamily" json:"address_family,omitempty"`
	Address       string          `protobuf:"bytes,2,opt,name=address" json:"address,omitempty"`
}

type IPAddressFamily int32

type IPRange struct {
	Address *IPAddress `protobuf:"bytes,1,opt,name=address" json:"address,omitempty"`
	Prefix  int32      `protobuf:"varint,2,opt,name=prefix" json:"prefix,omitempty"`
}

type NegotiateNeighborshipRequest struct {
}

type NegotiateNeighborshipResponse struct {
	// The identifier for this session
	SessionId *UUID `protobuf:"bytes,1,opt,name=session_id,json=sessionId" json:"session_id,omitempty"`
	// The amount of events a server has sent to the client
	EventCounter uint64 `protobuf:"varint,2,opt,name=event_counter,json=eventCounter" json:"event_counter,omitempty"`
}

type Neighbor struct {
	// The id of the neighbor message
	Id *UUID `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
	// The id of the client node
	ClientNode *UUID `protobuf:"bytes,2,opt,name=client_node,json=clientNode" json:"client_node,omitempty"`
	// The id of the server node
	ServerNode *UUID `protobuf:"bytes,3,opt,name=server_node,json=serverNode" json:"server_node,omitempty"`
	// A signature of the client node which confirms the validity and integrity
	ClientSignature *PGPSignature `protobuf:"bytes,4,opt,name=client_signature,json=clientSignature" json:"client_signature,omitempty"`
}

type Node struct {
	// The ID of the node
	Uuid *UUID `protobuf:"bytes,1,opt,name=uuid" json:"uuid,omitempty"`
	// The semantic version of the AbuseMesh protocol in use by the node
	ProtocolVersion string `protobuf:"bytes,2,opt,name=protocol_version,json=protocolVersion" json:"protocol_version,omitempty"`
	// The IP address on which the node is reachable
	IpAddress *IPAddress `protobuf:"bytes,3,opt,name=ip_address,json=ipAddress" json:"ip_address,omitempty"`
	// Details about how to contact the the company and/of administrators of a node
	ContactDetails *ContactDetails `protobuf:"bytes,4,opt,name=contact_details,json=contactDetails" json:"contact_details,omitempty"`
	// The number of the autonomous system for which this node claims to have authority
	ASN int32 `protobuf:"varint,5,opt,name=ASN" json:"ASN,omitempty"`
	// The PGP entity which the node uses to sign its messages
	PgpEntity *PGPEntity `protobuf:"bytes,6,opt,name=pgp_entity,json=pgpEntity" json:"pgp_entity,omitempty"`
}

type OfferSignatureRequest struct {
	Signature *PGPSignature `protobuf:"bytes,1,opt,name=signature" json:"signature,omitempty"`
}

type OfferSignatureResponse struct {
}

type PGPEntity struct {
	// The PGP packets of this pgp entity: the public key, userids, signatures and subkeys in binary format
	PgpPackets []byte `protobuf:"bytes,1,opt,name=pgp_packets,json=pgpPackets,proto3" json:"pgp_packets,omitempty"`
}

type PGPSignature struct {
	// A PGP detached signature packet of data
	Signature []byte `protobuf:"bytes,1,opt,name=signature,proto3" json:"signature,omitempty"`
}

type Report struct {
	// The id of the report
	Uuid *UUID `protobuf:"bytes,1,opt,name=uuid" json:"uuid,omitempty"`
	// The id of the node which created the report
	Reporter *UUID `protobuf:"bytes,2,opt,name=reporter" json:"reporter,omitempty"`
	// The id of the node which claims ownership over the AS where the abuse originated
	Suspect *UUID `protobuf:"bytes,3,opt,name=suspect" json:"suspect,omitempty"`
	// The signature that proves the reporter it the author of the report and that the report has no been modified
	Signature *PGPSignature `protobuf:"bytes,4,opt,name=signature" json:"signature,omitempty"`
	// The type of abuse this report specifies
	//
	// Types that are valid to be assigned to ReportAbuseType:
	//	*Report_UnstandardizedAbuseType
	//	*Report_AbuseType
	ReportAbuseType isReport_ReportAbuseType `protobuf_oneof:"report_abuse_type"`
	// A human readable description to give context
	// WARNING: this field should not be used for evidence, metadata or other machine data.
	Description string `protobuf:"bytes,7,opt,name=description" json:"description,omitempty"`
	// Types that are valid to be assigned to AbuseOrigin:
	//	*Report_Email
	//	*Report_DomainName
	//	*Report_Url
	//	*Report_Ip
	//	*Report_IpRange
	AbuseOrigin isReport_AbuseOrigin `protobuf_oneof:"abuse_origin"`
	// A key value map of evidence of abuse
	// e.g. when reporting spam, the recieved email can be included
	// e.g. for illegal scanning a log can be included
	// e.g. when reporting a DoS attack a anonymised PCAP can be included
	Evidence map[string]*Evidence `` /* 137-byte string literal not displayed */
	// A map containing extra details about the abuse type
	// e.g. when reporting a DoS attack the type of DOS attack can be a metadata field
	// TODO maybe this should be standardized as well at some point
	AbuseTypeMetadata map[string]string `` /* 182-byte string literal not displayed */
	// How was the abuse detected
	// e.g. spam filter
	// e.g. DDoS detector
	// e.g. human entry
	DetectionMethod *AbuseDetectionMethod `protobuf:"bytes,15,opt,name=detection_method,json=detectionMethod" json:"detection_method,omitempty"`
	// A map containing extra details about the detection method
	// e.g. which software version was used to detect the abuse
	// e.g. who created this report manually
	// TODO maybe this should be standardized as well at some point
	DetectionMethodMetadata map[string]string `` /* 200-byte string literal not displayed */
}

type ReportConfirmation struct {
	// The id of the report confirmation
	Uuid *UUID `protobuf:"bytes,1,opt,name=uuid" json:"uuid,omitempty"`
	// The id of node that created the confirmation
	Node *UUID `protobuf:"bytes,2,opt,name=node" json:"node,omitempty"`
	// The id of the report that is confirmed by this message
	Report *UUID `protobuf:"bytes,3,opt,name=report" json:"report,omitempty"`
	// The signature that proves the reporter it the author of the report and that the report has not been modified
	Signature *PGPSignature `protobuf:"bytes,4,opt,name=signature" json:"signature,omitempty"`
	// A human readable description of the confirmation
	// WARNING: this field should not be used for evidence or other machine data.
	Description string `protobuf:"bytes,5,opt,name=description" json:"description,omitempty"`
	// A key value map of evidence of abuse which should be indepently gathered
	// e.g. when reporting copyright infringement a http request and response can be added
	// e.g. when reporting a DoS attack a anonymised PCAP can be included
	Evidence map[string]*Evidence `` /* 136-byte string literal not displayed */
	// How was the abuse detected
	// e.g. spam filter
	// e.g. DDoS detector
	// e.g. human entry
	DetectionMethod *AbuseDetectionMethod `protobuf:"bytes,7,opt,name=detection_method,json=detectionMethod" json:"detection_method,omitempty"`
	// A map containing extra details about the detection method
	// e.g. which software version was used to detect the abuse
	// e.g. who created this report manually
	// TODO maybe this should be standardized as well at some point
	DetectionMethodMetadata map[string]string `` /* 199-byte string literal not displayed */
}

type Report_AbuseType struct {
	AbuseType AbuseType `protobuf:"varint,6,opt,name=abuse_type,json=abuseType,enum=abusemesh.AbuseType,oneof"`
}

type Report_DomainName struct {
	DomainName string `protobuf:"bytes,9,opt,name=domain_name,json=domainName,oneof"`
}

type Report_Email struct {
	Email string `protobuf:"bytes,8,opt,name=email,oneof"`
}

type Report_Ip struct {
	Ip *IPAddress `protobuf:"bytes,11,opt,name=ip,oneof"`
}

type Report_IpRange struct {
	IpRange *IPRange `protobuf:"bytes,12,opt,name=ip_range,json=ipRange,oneof"`
}

type Report_UnstandardizedAbuseType struct {
	UnstandardizedAbuseType string `protobuf:"bytes,5,opt,name=unstandardized_abuse_type,json=unstandardizedAbuseType,oneof"`
}

type Report_Url struct {
	Url string `protobuf:"bytes,10,opt,name=url,oneof"`
}

type TableEvent struct {
	// The unique id of this event
	EventId *UUID `protobuf:"bytes,1,opt,name=event_id,json=eventId" json:"event_id,omitempty"`
	// The id of the event before this one regarding the same entity
	// Is only set when `update_type` is EDIT or DELETE
	PreviousEvent *UUID `protobuf:"bytes,2,opt,name=previous_event,json=previousEvent" json:"previous_event,omitempty"`
	// The signature of `uuid` and `previous_event` signed with the same key as the entity
	EventSignature *PGPSignature  `protobuf:"bytes,3,opt,name=event_signature,json=eventSignature" json:"event_signature,omitempty"`
	UpdateType     TableEventType `protobuf:"varint,4,opt,name=update_type,json=updateType,enum=abusemesh.TableEventType" json:"update_type,omitempty"`
	// Types that are valid to be assigned to TableEntity:
	//	*TableEvent_Node
	//	*TableEvent_Neighbor
	//	*TableEvent_Report
	//	*TableEvent_ReportConfirmation
	//	*TableEvent_DelistRequests
	//	*TableEvent_DelistAcceptance
	TableEntity isTableEvent_TableEntity `protobuf_oneof:"table_entity"`
	// The event number of this event for the session between the server and client
	EventNumber uint64 `protobuf:"varint,11,opt,name=event_number,json=eventNumber" json:"event_number,omitempty"`
}

type TableEventStreamRequest struct {
	// The id of the session for which a client want to get the event stream
	SessionId *UUID `protobuf:"bytes,1,opt,name=session_id,json=sessionId" json:"session_id,omitempty"`
	// The event offset in the session the client requests
	Offset uint64 `protobuf:"varint,2,opt,name=offset" json:"offset,omitempty"`
}

type TableEventType int32

type TableEvent_DelistAcceptance struct {
	DelistAcceptance *DelistAcceptance `protobuf:"bytes,10,opt,name=delist_acceptance,json=delistAcceptance,oneof"`
}

type TableEvent_DelistRequests struct {
	DelistRequests *DelistRequest `protobuf:"bytes,9,opt,name=delist_requests,json=delistRequests,oneof"`
}

type TableEvent_Neighbor struct {
	Neighbor *Neighbor `protobuf:"bytes,6,opt,name=neighbor,oneof"`
}

type TableEvent_Node struct {
	Node *Node `protobuf:"bytes,5,opt,name=node,oneof"`
}

type TableEvent_Report struct {
	Report *Report `protobuf:"bytes,7,opt,name=report,oneof"`
}

type TableEvent_ReportConfirmation struct {
	ReportConfirmation *ReportConfirmation `protobuf:"bytes,8,opt,name=report_confirmation,json=reportConfirmation,oneof"`
}

type UUID struct {
	Uuid string `protobuf:"bytes,1,opt,name=uuid" json:"uuid,omitempty"`
}