You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

333 lines
11 KiB

8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
  1. # Building go-neb
  2. Go-neb is built using `gb` (https://getgb.io/). To build go-neb:
  3. ```bash
  4. # Install gb
  5. go get github.com/constabulary/gb/...
  6. # Clone the go-neb repository
  7. git clone https://github.com/matrix-org/go-neb
  8. cd go-neb
  9. # Build go-neb
  10. gb build github.com/matrix-org/go-neb
  11. ```
  12. # Running go-neb
  13. Go-neb uses environment variables to configure its database and bind address.
  14. To run go-neb:
  15. BIND_ADDRESS=:4050 DATABASE_TYPE=sqlite3 DATABASE_URL=go-neb.db BASE_URL=https://public.facing.endpoint bin/go-neb
  16. Go-neb needs to connect as a matrix user to receive messages. Go-neb can listen
  17. for messages as multiple matrix users. The users are configured using an
  18. HTTP API and the config is stored in the database. Go-neb will automatically
  19. start syncing matrix messages when the user is configured. To create a user:
  20. curl -X POST localhost:4050/admin/configureClient --data-binary '{
  21. "UserID": "@goneb:localhost:8448",
  22. "HomeserverURL": "http://localhost:8008",
  23. "AccessToken": "<access_token>"
  24. }'
  25. {
  26. "OldClient": {},
  27. "NewClient": {
  28. "UserID": "@goneb:localhost:8448",
  29. "HomeserverURL": "http://localhost:8008",
  30. "AccessToken": "<access_token>"
  31. }
  32. }
  33. Services in go-neb listen for messages in particular rooms using a given matrix
  34. user. Services are configured using an HTTP API and the config is stored in the
  35. database. Services use one of the matrix users configured on go-neb to receive
  36. matrix messages. Each service is configured to listen for messages in a set
  37. of rooms. Go-neb will automatically join the service to its rooms when it is
  38. configured. To start an echo service:
  39. curl -X POST localhost:4050/admin/configureService --data-binary '{
  40. "Type": "echo",
  41. "Id": "myserviceid",
  42. "Config": {
  43. "UserID": "@goneb:localhost:8448",
  44. "Rooms": ["!QkdpvTwGlrptdeViJx:localhost:8448"]
  45. }
  46. }'
  47. {
  48. "Type": "echo",
  49. "Id": "myserviceid",
  50. "OldConfig": {},
  51. "NewConfig": {
  52. "UserID": "@goneb:localhost:8448",
  53. "Rooms": ["!QkdpvTwGlrptdeViJx:localhost:8448"]
  54. }
  55. }
  56. To retrieve an existing Service:
  57. curl -X POST localhost:4050/admin/getService --data-binary '{
  58. "Id": "myserviceid"
  59. }'
  60. {
  61. "Type": "echo",
  62. "Id": "myserviceid",
  63. "Config": {
  64. "UserID": "@goneb:localhost:8448",
  65. "Rooms": ["!QkdpvTwGlrptdeViJx:localhost:8448"]
  66. }
  67. }
  68. Go-neb has a heartbeat listener that returns 200 OK so that load balancers can
  69. check that the server is still running.
  70. curl -X GET localhost:4050/test
  71. {}
  72. ## Architecture
  73. ```
  74. HOMESERVER
  75. |
  76. +=============================================================+
  77. | | Go-NEB |
  78. | +---------+ |
  79. | | Clients | |
  80. | +---------+ |
  81. | | |
  82. | +---------+ +------------+ +--------------+ |
  83. | | Service |-------| Auth Realm |------| Auth Session |-+ |
  84. | +---------+ +------------+ +--------------+ | |
  85. | ^ ^ +---------------+ |
  86. | | | |
  87. +=============================================================+
  88. | |
  89. WEBHOOK REDIRECT
  90. REQUEST REQUEST
  91. Clients = A thing which can talk to homeservers and listen for events.
  92. Service = An individual bot, configured by a user.
  93. Auth Realm = A place where a user can authenticate with.
  94. Auth Session = An individual authentication session
  95. ```
  96. Some `AuthRealms` support "Starter Links". These are HTTP URLs which knowledgeable clients should use to *start* the auth process. They are commonly returned as metadata to `!commands`.
  97. These links require the client to prove that they own a given user ID by appending a token
  98. to the Starter Link. This token will be used to verify the client's identity by making an
  99. Open ID request to the user's Homeserver via federation.
  100. ## Starting a Github Service
  101. ### Register a Github realm
  102. This API allows for an optional `StarterLink` value.
  103. ```
  104. curl -X POST localhost:4050/admin/configureAuthRealm --data-binary '{
  105. "ID": "mygithubrealm",
  106. "Type": "github",
  107. "Config": {
  108. "ClientSecret": "YOUR_CLIENT_SECRET",
  109. "ClientID": "YOUR_CLIENT_ID",
  110. "StarterLink": "https://example.com/requestGithubOAuthToken"
  111. }
  112. }'
  113. ```
  114. Returns:
  115. ```
  116. {
  117. "ID":"mygithubrealm",
  118. "Type":"github",
  119. "OldConfig":null,
  120. "NewConfig":{
  121. "ClientSecret":"YOUR_CLIENT_SECRET",
  122. "ClientID":"YOUR_CLIENT_ID",
  123. "StarterLink": "https://example.com/requestGithubOAuthToken"
  124. }
  125. }
  126. ```
  127. ### Make a request for Github Auth
  128. ```
  129. curl -X POST localhost:4050/admin/requestAuthSession --data-binary '{
  130. "RealmID": "mygithubrealm",
  131. "UserID": "@your_user_id:localhost",
  132. "Config": {
  133. }
  134. }'
  135. ```
  136. Returns:
  137. ```
  138. {
  139. "URL":"https://github.com/login/oauth/authorize?client_id=$ID\u0026client_secret=$SECRET\u0026redirect_uri=$REDIRECT_BASE_URI%2Frealms%2Fredirects%2Fmygithubrealm\u0026state=$RANDOM_STRING"
  140. }
  141. ```
  142. Follow this link and grant access for NEB to act on your behalf.
  143. ### Create a github bot
  144. ```
  145. curl -X POST localhost:4050/admin/configureService --data-binary '{
  146. "Type": "github",
  147. "Id": "mygithubserviceid",
  148. "Config": {
  149. "RealmID": "mygithubrealm",
  150. "BotUserID": "@goneb:localhost",
  151. "ClientUserID": "@example:localhost",
  152. "Rooms": {
  153. "!EmwxeXCVubhskuWvaw:localhost": {
  154. "Repos": {
  155. "owner/repo": {
  156. "Events": ["push","issues"]
  157. }
  158. }
  159. }
  160. }
  161. }
  162. }'
  163. ```
  164. This request will make `BotUserID` join the `Rooms` specified and create webhooks for the `owner/repo` projects given.
  165. ## Starting a JIRA Service
  166. ### Register a JIRA realm
  167. Generate an RSA private key: (JIRA does not support key sizes >2048 bits)
  168. ```bash
  169. openssl genrsa -out privkey.pem 2048
  170. cat privkey.pem
  171. ```
  172. This API allows for an optional `StarterLink` value. Create the realm:
  173. ```
  174. curl -X POST localhost:4050/admin/configureAuthRealm --data-binary '{
  175. "ID": "jirarealm",
  176. "Type": "jira",
  177. "Config": {
  178. "JIRAEndpoint": "matrix.org/jira/",
  179. "StarterLink": "https://example.com/requestJIRAOAuthToken",
  180. "ConsumerName": "goneb",
  181. "ConsumerKey": "goneb",
  182. "ConsumerSecret": "random_long_string",
  183. "PrivateKeyPEM": "-----BEGIN RSA PRIVATE KEY-----\r\nMIIEowIBAAKCAQEA39UhbOvQHEkBP9fGnhU+eSObTWBDGWygVYzbcONOlqEOTJUN\r\n8gmnellWqJO45S4jB1vLLnuXiHqEWnmaShIvbUem3QnDDqghu0gfqXHMlQr5R8ZP\r\norTt1F2idWy1wk5rVXeLKSG7uriYhDVOVS69WuefoW5v55b5YZV283v2jROjxHuj\r\ngAsJA7k6tvpYiSXApUl6YHmECfBoiwG9bwItkHwhZ\/fG9i4H8\/aOyr3WlaWbVeKX\r\n+m38lmYZvzQFRAk5ab1vzCGz4cyc\r\nTk2qmZpcjHRd1ijcOkgC23KF8lHWF5Zx0tySR+DWL1JeGm8NJxKMRJZuE8MIkJYF\r\nryE7kjspNItk6npkA3\/A4PWwElhddI4JpiuK+29mMNipRcYYy9e0vH\/igejv7ayd\r\nPLCRMQKBgBDSNWlZT0nNd2DXVqTW9p+MG72VKhDgmEwFB1acOw0lpu1XE8R1wmwG\r\nZRl\/xzri3LOW2Gpc77xu6fs3NIkzQw3v1ifYhX3OrVsCIRBbDjPQI3yYjkhGx24s\r\nVhhZ5S\/TkGk3Kw59bDC6KGqAuQAwX9req2l1NiuNaPU9rE7tf6Bk\r\n-----END RSA PRIVATE KEY-----"
  184. }
  185. }'
  186. ```
  187. The following keys will be modified/added:
  188. - `JIRAEndpoint` in canonicalised form.
  189. - `Server` and `Version` keys which are purely informational for the caller.
  190. - `PublicKeyPEM` which the caller needs a human to insert into the JIRA Application Links web form.
  191. Returns:
  192. ```json
  193. {
  194. "ID": "jirarealm",
  195. "Type": "jira",
  196. "OldConfig": null,
  197. "NewConfig": {
  198. "JIRAEndpoint": "https://matrix.org/jira/",
  199. "StarterLink": "https://example.com/requestJIRAOAuthToken",
  200. "Server": "Matrix.org",
  201. "Version": "6.3.5a",
  202. "ConsumerName": "goneb",
  203. "ConsumerKey": "goneb",
  204. "ConsumerSecret": "random_long_string",
  205. "PublicKeyPEM": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA39UhbOvQHEkBP9fGnhU+\neSObTWBDGWygVYzbcONOlqEOTJUN8gmnellWqJO45S4jB1vLLnuXiHqEWnmaShIv\nbUem3QnDDqghu0gfqXHMlQr5R8ZPorTt1F2idWy1wk5rVXeLKSG7uriYhDVOVS69\nWuefoW5v55b5YZV283v2jROjxHujgAsJA7k6tvpYiSXApUl6YHmECfBoiwG9bwIt\nkHwhZ/fG9i4H8/aOyr3WlaWbVeKX+m38lmYZvzQFRd7UPU7DuO6Aiqj7RxrbAvqq\ndPeoAvo6+V0TRPZ8YzKp2yQmDcGH69IbuKJ2BG1Qx8znZAvghKQ6P9Im+M4c7j9i\ndwIDAQAB\n-----END PUBLIC KEY-----\n",
  206. "PrivateKeyPEM": "-----BEGIN RSA PRIVATE KEY-----\r\nMIIEowIBAAKCAQEA39UhbOvQHEkBP9fGnhU+eSObTWBDGWygVYzbcONOlqEOTJUN\r\n8gmnellWqJO45S4jB1vLLnuXiHqEWnmaShIvbUem3QnDDqghu0gfqXHMlQr5R8ZP\r\norTt1F2idWy1wk5rVXeLKSG7uriYhDVOVS69WuefoW5v55b5YZV283v2jROjxHuj\r\ngAsJA7k6tvpYiSXApUl6YHmECfBoiwG9bwItkHwhZ/fG9i4H8/aOyr3WlaWbVeKX\r\n+m38lmYZvzQFRd7UPU7DuO6Aiqj7RxrbAvqqdPeoAvo6+V0TRPZ8YzKp2yQmDcGH\r\n69IbuKJ2BG1Qx8znZAvghKQ6P9Im+M4c7j9iMG72VKhDgmEwFB1acOw0lpu1XE8R1wmwG\r\nZRl/xzri3LOW2Gpc77xu6fs3NIkzQw3v1ifYhX3OrVsCIRBbDjPQI3yYjkhGx24s\r\nVhhZ5S/TkGk3Kw59bDC6KGqAuQAwX9req2l1NiuNaPU9rE7tf6Bk\r\n-----END RSA PRIVATE KEY-----"
  207. }
  208. }
  209. ```
  210. The `ConsumerKey`, `ConsumerSecret`, `ConsumerName` and `PublicKeyPEM` must be manually inserted
  211. into the "Application Links" section under JIRA Admin Settings by a JIRA admin on the target
  212. JIRA installation. Once that is complete, users can OAuth on the target JIRA installation.
  213. ### Make a request for JIRA Auth
  214. ```
  215. curl -X POST localhost:4050/admin/requestAuthSession --data-binary '{
  216. "RealmID": "jirarealm",
  217. "UserID": "@example:localhost",
  218. "Config": {
  219. }
  220. }'
  221. ```
  222. Returns:
  223. ```json
  224. {
  225. "URL":"https://jira.somewhere.com/plugins/servlet/oauth/authorize?oauth_token=7yeuierbgweguiegrTbOT"
  226. }
  227. ```
  228. Follow this link and grant access for NEB to act on your behalf.
  229. ### Create a JIRA bot
  230. ```
  231. curl -X POST localhost:4050/admin/configureService --data-binary '{
  232. "Type": "jira",
  233. "Id": "jid",
  234. "Config": {
  235. "BotUserID": "@goneb:localhost",
  236. "ClientUserID": "@example:localhost",
  237. "Rooms": {
  238. "!EmwxeXCVubhskuWvaw:localhost": {
  239. "Realms": {
  240. "jira_realm_id": {
  241. "Projects": {
  242. "BOTS": {
  243. "Expand": true,
  244. "Track": true
  245. }
  246. }
  247. }
  248. }
  249. }
  250. }
  251. }
  252. }'
  253. ```
  254. # Developing on go-neb.
  255. There's a bunch more tools this project uses when developing in order to do
  256. things like linting. Some of them are bundled with go (fmt and vet) but some
  257. are not. You should install the ones which are not:
  258. ```bash
  259. go get github.com/golang/lint/golint
  260. go get github.com/fzipp/gocyclo
  261. ```
  262. You can then install the pre-commit hook:
  263. ```bash
  264. ./hooks/install.sh
  265. ```
  266. ## Viewing the API docs.
  267. ```
  268. # Start a documentation server listening on :6060
  269. GOPATH=$GOPATH:$(pwd) godoc -v -http=localhost:6060 &
  270. # Open up the documentation for go-neb in a browser.
  271. sensible-browser http://localhost/pkg/github.com/matrix-org/go-neb
  272. ```