{"id":22276489,"url":"https://github.com/uedatakeyuki/message","last_synced_at":"2025-03-25T17:27:53.210Z","repository":{"id":57655800,"uuid":"456751477","full_name":"UedaTakeyuki/message","owner":"UedaTakeyuki","description":"An out-of-the-box cryptographic message communication.","archived":false,"fork":false,"pushed_at":"2024-05-14T11:41:04.000Z","size":273,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-01-30T15:33:46.603Z","etag":null,"topics":["criptography","go"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/UedaTakeyuki.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"license.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-02-08T02:17:13.000Z","updated_at":"2024-05-14T11:41:08.000Z","dependencies_parsed_at":"2024-05-09T14:46:57.771Z","dependency_job_id":"86a10729-ef71-497d-9f19-dcda396e8c6a","html_url":"https://github.com/UedaTakeyuki/message","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UedaTakeyuki%2Fmessage","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UedaTakeyuki%2Fmessage/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UedaTakeyuki%2Fmessage/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UedaTakeyuki%2Fmessage/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/UedaTakeyuki","download_url":"https://codeload.github.com/UedaTakeyuki/message/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245509955,"owners_count":20627092,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["criptography","go"],"created_at":"2024-12-03T14:14:54.599Z","updated_at":"2025-03-25T17:27:53.189Z","avatar_url":"https://github.com/UedaTakeyuki.png","language":"Go","readme":"# message\n\nAn out-of-the-box cryptographic message communication.\n\n## how to use\n\n### Using high-level APIs\n```\nimport(\n\t\"github.com/UedaTakeyuki/message\"\n)\n// original message \nconst originalMessage = \"some plaintext\"\n\n// an aad for AESGCM\nvar aad = []byte(\"Some AAD data\")\n\n// keys\nvar key_256 = []byte(\"01234567890123456789012345678901\")\nvar key_192 = []byte(\"012345678901234567890123\")\nvar key_128 = []byte(\"0123456789012345\")\n\n// encript by AESCTR with 256 bit key\ncrypticmessage, mac, err := message.EncriptStringByAESCTR(key_256, originalMessage)\n\n// decript \ndecriptedmessage, err2 := message.DecriptStringByAESCTR(key_256, crypticmessage)\n```\nFor more examples, refer [Test_02_test.go](test/Test_02_test.go) and [Test_03_test.go](test/Test_03_test.go)\n\n### Direct use of AES classes\n#### 1. encript \u0026 decript\n```\nimport(\n\t\"github.com/UedaTakeyuki/message\"\n)\n\nfunc encriptAndEncode(plainmessage []byte) (crypticmessage string) {\n\n\t// new AESCTR\n\tm := new(message.AESCTR)\n\n\t// set key\n\tm.SetKey([]byte(\"01234567890123456789012345678901\"))\n\n\t// set plainmessage for encription\n\tm.SetPlainMessage(plainmessage)\n\n\t// get criptic message\n\tcrypticmessage = m.GetEncodedEncriptedMessage()\n\tlog.Println(\"crypticmessage:\", crypticmessage)\n\n\treturn\n}\n\nfunc decodeAndDecript(crypticmessage string) {\n\n\t// new AESCTR\n\tm := new(message.AESCTR)\n\n\t// set key\n\tm.SetKey([]byte(\"01234567890123456789012345678901\"))\n\n\t// set criptic message string\n\tm.SetEncodedEncriptedMessage(crypticmessage)\n\n\t// get original message from cryptic message\n\tdecreiptedMessage := m.GetDecriptedMessage()\n\tlog.Println(\"decreiptedMessage:\", string(decreiptedMessage))\n\n}\n\nfunc main(){\n\tcrypticmessage, mac := encriptAndEncode([]byte(originalMessage))\n\tdecodeAndDecript(crypticmessage, mac)\n}\n```\n\nOutput message:   \n\n```\ncrypticmessage: L0z3LU3pmWNUvGr-w1eSzRLZpcuajcjy84Qa4Zq1\ndecreiptedMessage: some plaintext\n```\n#### 2. encript and authenticate \u0026 decript and authentication confirm\n```\nimport(\n\t  \"github.com/UedaTakeyuki/message\"\n)\n\nfunc encriptAndEncode(plainmessage []byte) (crypticmessage string, mac string) {\n\n\t// new AESCTR\n\tm := new(message.AESCTR)\n\n\t// set key\n\tm.SetKey([]byte(\"01234567890123456789012345678901\"))\n\n\t// set plainmessage for encription\n\tm.SetPlainMessage(plainmessage)\n\n\t// get criptic message\n\tcrypticmessage = m.GetEncodedEncriptedMessage()\n\tlog.Println(\"crypticmessage:\", crypticmessage)\n\n\t// get Authentication Code of this message\n\tmac = m.GetPlainMessageMac()\n\tlog.Println(\"hmac of plaintext:\", mac)\n\n\treturn\n}\n\nfunc decodeAndDecript(crypticmessage string, mac string) {\n\n\t// new AESCTR\n\tm := new(message.AESCTR)\n\n\t// set key\n\tm.SetKey([]byte(\"01234567890123456789012345678901\"))\n\n\t// set criptic message string\n\tm.SetEncodedEncriptedMessage(crypticmessage)\n\n\t// get original message from cryptic message\n\tdecreiptedMessage := m.GetDecriptedMessage()\n\tlog.Println(\"decreiptedMessage:\", string(decreiptedMessage))\n\n\t// confirm Authentication Code\n\tresult, _ := m.ConfirmMacFromstring(mac)\n\tlog.Println(\"Confrimation result is\", result)\n}\n\nfunc main(){\n\tcrypticmessage, mac := encriptAndEncode([]byte(originalMessage))\n\tdecodeAndDecript(crypticmessage, mac)\n}\n```\n\nOutput message:   \n\n```\ncrypticmessage: L0z3LU3pmWNUvGr-w1eSzRLZpcuajcjy84Qa4Zq1\nhmac of plaintext: cdd1aba74001d40e980de7cee69dc10d8495a609936bc835da4b30cb33ab6f50\ndecreiptedMessage: some plaintext\nConfrimation result is true\n```\n\nFor more examples, refer [Test_01_test.go](test/Test_01_test.go)\n\n## structure\n### hight level API\n![](docs/global.png)\n\nAccording to this [answer](https://softwareengineering.stackexchange.com/a/302170/444238), I've expressed global functions with stereotype.\n\n### class interface\n![](docs/class.png)\n\n## supported algorithm\n- [x] AES CTR + HMAC (encription: AES CTR, message authentication: HMAC)\n- [x] AESGCM (both encription and message authentication are supported by AES GCM)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuedatakeyuki%2Fmessage","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fuedatakeyuki%2Fmessage","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuedatakeyuki%2Fmessage/lists"}