dimp

Documentation

Overview

license: https://mit-license.org * ============================================================================== * The MIT License (MIT) * * Copyright (c) 2021 Albert Moky * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in all * copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. * ==============================================================================

license: https://mit-license.org * ============================================================================== * The MIT License (MIT) * * Copyright (c) 2021 Albert Moky * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in all * copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. * ==============================================================================

license: https://mit-license.org * ============================================================================== * The MIT License (MIT) * * Copyright (c) 2021 Albert Moky * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in all * copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. * ==============================================================================

Index

• Variables
• func AnonymousGetName(identifier ID) string
• func AnonymousGetNumber(address Address) uint32
• func AnonymousGetNumberString(address Address) string
• func GeneratePassword(password string) SymmetricKey
• type GroupInfo
  • func GenerateGroupInfo(founder *UserInfo, name string, seed string) *GroupInfo
• type UserInfo
  • func GenerateRobotInfo(seed string, name string, avatar string) *UserInfo
  • func GenerateStationInfo(seed string, name string, logo string, host string, port uint16) *UserInfo
  • func GenerateUserInfo(name string, avatar string) *UserInfo

Variables

var BlockSize = 16

var KeySize = 32

Functions

func AnonymousGetName

func AnonymousGetName(identifier ID) string

func AnonymousGetNumber

func AnonymousGetNumber(address Address) uint32

func AnonymousGetNumberString

func AnonymousGetNumberString(address Address) string

func GeneratePassword

func GeneratePassword(password string) SymmetricKey

*

• This is for generating symmetric key with a text string

Types

type GroupInfo

type GroupInfo struct {
	ID ID

	Meta     Meta
	Bulletin Document
}

func GenerateGroupInfo

func GenerateGroupInfo(founder *UserInfo, name string, seed string) *GroupInfo

*

• Generate group account info *
• @param founder - group founder
• @param name - group name
• @return Group object

type UserInfo

type UserInfo struct {
	ID ID

	Meta Meta
	Visa Document

	IdentityKey      SignKey
	CommunicationKey DecryptKey
}

func GenerateRobotInfo

func GenerateRobotInfo(seed string, name string, avatar string) *UserInfo

*

• Generate robot account info *
• @param seed - meta seed for ID.name
• @param name - robot name
• @param avatar - photo URL
• @return robot info

func GenerateStationInfo

func GenerateStationInfo(seed string, name string, logo string, host string, port uint16) *UserInfo

*

• Generate station account info *
• @param seed - meta seed for ID.name
• @param name - station name
• @param logo - service provider logo URL
• @param host - station IP
• @param port - station port
• @return station info

func GenerateUserInfo

func GenerateUserInfo(name string, avatar string) *UserInfo

*

• Generate user account info *
• @param name - nickname
• @param avatar - photo URL
• @return user info