BinaryNinja::Collaboration::Remote Class Reference

Public Member Functions
	Remote (BNRemote *remote)
std::string	GetUniqueId ()
std::string	GetName ()
std::string	GetAddress ()
bool	HasLoadedMetadata ()
bool	IsConnected ()
std::string	GetUsername ()
std::string	GetToken ()
int	GetServerVersion ()
std::string	GetServerBuildId ()
std::vector< std::pair< std::string, std::string > >	GetAuthBackends ()
bool	HasPulledProjects ()
bool	HasPulledUsers ()
bool	HasPulledGroups ()
bool	IsAdmin ()
bool	IsEnterprise ()
	Determine if a remote is the same as the currently connected Enterprise Server On non-Enterprise clients, this always returns false.
bool	LoadMetadata ()
	Load remote metadata, including version, id, and auth backends.
std::string	RequestAuthenticationToken (const std::string &username, const std::string &password)
	Request an authentication token for a user given a username and password.
void	Connect (const std::string &username, const std::string &token)
	Establish a connection to the remote, using a username and token.
void	Disconnect ()
	Disconnect from the remote.
std::vector< Ref< RemoteProject > >	GetProjects ()
	Get all projects in the Remote.
Ref< RemoteProject >	GetProjectById (const std::string &id)
	Get a project in the remote by its id.
Ref< RemoteProject >	GetProjectByName (const std::string &name)
	Get a project in the remote by its name.
void	PullProjects (std::function< bool(size_t, size_t)> progress={})
	Pull list of projects from the remote.
Ref< RemoteProject >	CreateProject (const std::string &name, const std::string &description)
	Create a new project on the remote (and pull it)
Ref< RemoteProject >	ImportLocalProject (Ref< Project > localProject, std::function< bool(size_t, size_t)> progress={})
	Create a new project on the remote from a local project.
void	PushProject (Ref< RemoteProject > project, const std::vector< std::pair< std::string, std::string > > &extraFields={})
	Push fields of a modified project to the remote.
void	DeleteProject (const Ref< RemoteProject > project)
	Delete a project from the remote.
std::vector< Ref< CollabGroup > >	GetGroups ()
	Get all groups in the Project.
Ref< CollabGroup >	GetGroupById (uint64_t id)
	Get a group in the project by its id.
Ref< CollabGroup >	GetGroupByName (const std::string &name)
	Get a group in the project by its name.
std::vector< std::pair< uint64_t, std::string > >	SearchGroups (const std::string &prefix)
	Search groups on the remote.
void	PullGroups (std::function< bool(size_t, size_t)> progress={})
	Pull list of groups from the remote.
Ref< CollabGroup >	CreateGroup (const std::string &name, const std::vector< std::string > &usernames)
	Create a new group on the remote (and pull it)
void	PushGroup (Ref< CollabGroup > group, const std::vector< std::pair< std::string, std::string > > &extraFields={})
	Push fields of a modified group to the remote.
void	DeleteGroup (const Ref< CollabGroup > group)
	Delete a group from the remote.
std::vector< Ref< CollabUser > >	GetUsers ()
	Get all users in the Remote.
Ref< CollabUser >	GetUserById (const std::string &id)
	Get a user in the remote by their id.
Ref< CollabUser >	GetUserByUsername (const std::string &username)
	Get a user in the remote by their username.
Ref< CollabUser >	GetCurrentUser ()
	Get the currently logged-in user's CollabUser object.
std::vector< std::pair< std::string, std::string > >	SearchUsers (const std::string &prefix)
	Search users on the remote.
void	PullUsers (std::function< bool(size_t, size_t)> progress={})
	Pull list of users from the remote.
Ref< CollabUser >	CreateUser (const std::string &username, const std::string &email, bool is_active, const std::string &password, const std::vector< uint64_t > &groupIds, const std::vector< uint64_t > &userPermissionIds)
	Create a new user on the remote (and pull it)
void	PushUser (Ref< CollabUser > user, const std::vector< std::pair< std::string, std::string > > &extraFields={})
	Push fields of a modified user to the remote.
int	Request (Http::Request request, Http::Response &ret)
	Perform an arbitrary HTTP request.
Public Member Functions inherited from BinaryNinja::CoreRefCountObject< BNRemote, BNNewRemoteReference, BNFreeRemote >
	CoreRefCountObject ()
virtual	~CoreRefCountObject ()
BNRemote *	GetObject () const
void	AddRef ()
void	Release ()
void	AddRefForRegistration ()
void	ReleaseForRegistration ()
void	AddRefForCallback ()
void	ReleaseForCallback ()

Additional Inherited Members
Static Public Member Functions inherited from BinaryNinja::CoreRefCountObject< BNRemote, BNNewRemoteReference, BNFreeRemote >
static BNRemote *	GetObject (CoreRefCountObject *obj)
static BNRemote *	GetObject (const CoreRefCountObject *obj)
Public Attributes inherited from BinaryNinja::CoreRefCountObject< BNRemote, BNNewRemoteReference, BNFreeRemote >
std::atomic< int >	m_refs
bool	m_registeredRef
BNRemote *	m_object

Constructor & Destructor Documentation

Remote()

Remote::Remote

(

BNRemote *

remote

)

Member Function Documentation

GetUniqueId()

std::string Remote::GetUniqueId

(

)

GetName()

std::string Remote::GetName

(

)

GetAddress()

std::string Remote::GetAddress

(

)

HasLoadedMetadata()

bool Remote::HasLoadedMetadata

(

)

IsConnected()

bool Remote::IsConnected

(

)

GetUsername()

std::string Remote::GetUsername

(

)

GetToken()

std::string Remote::GetToken

(

)

GetServerVersion()

int Remote::GetServerVersion

(

)

GetServerBuildId()

std::string Remote::GetServerBuildId

(

)

GetAuthBackends()

std::vector< std::pair< std::string, std::string > > Remote::GetAuthBackends

(

)

HasPulledProjects()

bool Remote::HasPulledProjects

(

)

HasPulledUsers()

bool Remote::HasPulledUsers

(

)

HasPulledGroups()

bool Remote::HasPulledGroups

(

)

IsAdmin()

bool Remote::IsAdmin

(

)

IsEnterprise()

bool Remote::IsEnterprise

(

)

Determine if a remote is the same as the currently connected Enterprise Server On non-Enterprise clients, this always returns false.

Returns

True if the remote is the same

LoadMetadata()

bool Remote::LoadMetadata

(

)

Load remote metadata, including version, id, and auth backends.

Exceptions

RemoteException

If there is an error in any request, or if the remote version is not supported

RequestAuthenticationToken()

std::string Remote::RequestAuthenticationToken	(	const std::string &	username,
		const std::string &	password )

Request an authentication token for a user given a username and password.

Parameters

username	CollabUser's username
password	CollabUser's password

Returns

Authentication token

Exceptions

RemoteException

If there is an error in any request

Connect()

void Remote::Connect	(	const std::string &	username,
		const std::string &	token )

Establish a connection to the remote, using a username and token.

Parameters

username	CollabUser's username
token	CollabUser's authentication token

Exceptions

RemoteException

If there is an error in any request

Disconnect()

void Remote::Disconnect

(

)

Disconnect from the remote.

GetProjects()

std::vector< Ref< RemoteProject > > Remote::GetProjects

(

)

Get all projects in the Remote.

Returns

All projects

Exceptions

RemoteException

if projects have not been pulled or if the remote is not connected

GetProjectById()

Ref< RemoteProject > Remote::GetProjectById

(

const std::string &

id

)

Get a project in the remote by its id.

Parameters

id	Project's id

Returns

Project, or null shared_ptr if not found

Exceptions

RemoteException

If projects have not been pulled or if the remote is not connected

GetProjectByName()

Ref< RemoteProject > Remote::GetProjectByName

(

const std::string &

name

)

Get a project in the remote by its name.

Parameters

name	Project's name

Returns

Project, or null shared_ptr if not found

Exceptions

RemoteException

If projects have not been pulled or if the remote is not connected

PullProjects()

void Remote::PullProjects

(

std::function< bool(size_t, size_t)>

progress = {}

)

Pull list of projects from the remote.

Necessary before calling GetProjects()

Parameters

progress

Function to call on progress updates

Exceptions

RemoteException

If there is an error in any request or if the remote is not connected

CreateProject()

Ref< RemoteProject > Remote::CreateProject	(	const std::string &	name,
		const std::string &	description )

Create a new project on the remote (and pull it)

Parameters

name	Project name
description	Project description

Returns

Reference to the created project

Exceptions

RemoteException

If there is an error in any request or if the remote is not connected

ImportLocalProject()

Ref< RemoteProject > Remote::ImportLocalProject	(	Ref< Project >	localProject,
		std::function< bool(size_t, size_t)>	progress = {} )

Create a new project on the remote from a local project.

Parameters

localProject	The local project that should be copied to the server
progress	Function to call on progress updates

Returns

Reference to the created project

Exceptions

RemoteException

If there is an error in any request or if the remote is not connected

PushProject()

void Remote::PushProject	(	Ref< RemoteProject >	project,
		const std::vector< std::pair< std::string, std::string > > &	extraFields = {} )

Push fields of a modified project to the remote.

Parameters

project	Updated project
extraFields	Extra post fields for the request

Exceptions

RemoteException

If there is an error in any request or if the remote is not connected

DeleteProject()

void Remote::DeleteProject

(

const Ref< RemoteProject >

project

)

Delete a project from the remote.

Parameters

project

Pointer to project to delete (will invalidate pointer)

Exceptions

RemoteException

If there is an error in any request or if the remote is not connected

GetGroups()

std::vector< Ref< CollabGroup > > Remote::GetGroups

(

)

Get all groups in the Project.

Returns

All groups

Exceptions

RemoteException

if groups have not been pulled or if the remote is not connected

GetGroupById()

Ref< CollabGroup > Remote::GetGroupById

(

uint64_t

id

)

Get a group in the project by its id.

Parameters

id	Group's id

Returns

Group, or null shared_ptr if not found

Exceptions

RemoteException

If groups have not been pulled or if the remote is not connected

GetGroupByName()

Ref< CollabGroup > Remote::GetGroupByName

(

const std::string &

name

)

Get a group in the project by its name.

Will check for both name and <project id>/name

Parameters

name	Group's name

Returns

Group, or null shared_ptr if not found

Exceptions

RemoteException

If groups have not been pulled or if the remote is not connected

SearchGroups()

std::vector< std::pair< uint64_t, std::string > > Remote::SearchGroups

(

const std::string &

prefix

)

Search groups on the remote.

Parameters

prefix

Prefix to search for

Exceptions

RemoteException

If there is an error in any request or if the remote is not connected

PullGroups()

void Remote::PullGroups

(

std::function< bool(size_t, size_t)>

progress = {}

)

Pull list of groups from the remote.

Necessary before calling GetGroups()

Parameters

progress

Function to call on progress updates

Exceptions

RemoteException

If there is an error in any request or if the remote is not connected

CreateGroup()

Ref< CollabGroup > Remote::CreateGroup	(	const std::string &	name,
		const std::vector< std::string > &	usernames )

Create a new group on the remote (and pull it)

Parameters

name	Group name

Returns

Reference to the created group

Exceptions

RemoteException

If there is an error in any request or if the remote is not connected

PushGroup()

void Remote::PushGroup	(	Ref< CollabGroup >	group,
		const std::vector< std::pair< std::string, std::string > > &	extraFields = {} )

Push fields of a modified group to the remote.

Parameters

group	Updated group
extraFields	Extra post fields for the request

Exceptions

RemoteException

If there is an error in any request or if the remote is not connected

DeleteGroup()

void Remote::DeleteGroup

(

const Ref< CollabGroup >

group

)

Delete a group from the remote.

Parameters

group

Pointer to group to delete (will invalidate pointer)

Exceptions

RemoteException

If there is an error in any request or if the remote is not connected

GetUsers()

std::vector< Ref< CollabUser > > Remote::GetUsers

(

)

Get all users in the Remote.

Returns

All users

Exceptions

RemoteException

if users have not been pulled or if the remote is not connected

GetUserById()

Ref< CollabUser > Remote::GetUserById

(

const std::string &

id

)

Get a user in the remote by their id.

Parameters

id	CollabUser's id

Returns

CollabUser, or null shared_ptr if not found

Exceptions

RemoteException

If users have not been pulled or if the remote is not connected

GetUserByUsername()

Ref< CollabUser > Remote::GetUserByUsername

(

const std::string &

username

)

Get a user in the remote by their username.

Parameters

username

CollabUser's username

Returns

CollabUser, or null shared_ptr if not found

Exceptions

RemoteException

If users have not been pulled or if the remote is not connected

GetCurrentUser()

Ref< CollabUser > Remote::GetCurrentUser

(

)

Get the currently logged-in user's CollabUser object.

Returns

The current user's CollabUser, or null shared_ptr if not found

Exceptions

RemoteException

if users have not been pulled or if the remote is not connected

SearchUsers()

std::vector< std::pair< std::string, std::string > > Remote::SearchUsers

(

const std::string &

prefix

)

Search users on the remote.

Parameters

prefix

Prefix to search for

Exceptions

RemoteException

If there is an error in any request or if the remote is not connected

PullUsers()

void Remote::PullUsers

(

std::function< bool(size_t, size_t)>

progress = {}

)

Pull list of users from the remote.

Necessary before calling GetUsers()

Parameters

progress

Function to call on progress updates

Exceptions

RemoteException

If there is an error in any request or if the remote is not connected

CreateUser()

Ref< CollabUser > Remote::CreateUser	(	const std::string &	username,
		const std::string &	email,
		bool	is_active,
		const std::string &	password,
		const std::vector< uint64_t > &	groupIds,
		const std::vector< uint64_t > &	userPermissionIds )

Create a new user on the remote (and pull it)

Parameters

name	CollabUser name
email	CollabUser email
is_active	If the user should initially be active
password	CollabUser password
groupIds	List of group ids the user will be added to
userPermissionIds	List of permission ids the user will be granted

Returns

Reference to the created user

Exceptions

RemoteException

If there is an error in any request or if the remote is not connected

PushUser()

void Remote::PushUser	(	Ref< CollabUser >	user,
		const std::vector< std::pair< std::string, std::string > > &	extraFields = {} )

Push fields of a modified user to the remote.

Parameters

user	Updated user
extraFields	Extra post fields for the request (eg password)

Exceptions

RemoteException

If there is an error in any request or if the remote is not connected

Request()

int Remote::Request	(	Http::Request	request,
		Http::Response &	ret )

Perform an arbitrary HTTP request.

An "Authorization: Token <token>" header will be added with the Remote's token for the current login session.

Parameters

request	Request structure with headers and content.
response	Response structure with body

Returns

Zero or greater on success