{"_id":"5567445f77c15523002fd57f","parentDoc":null,"user":"5564f227f0f70f0d00a9ab20","version":{"_id":"5564f26a1fd04c0d00dc9aad","project":"5564f26a1fd04c0d00dc9aaa","__v":15,"createdAt":"2015-05-26T22:23:38.671Z","releaseDate":"2015-05-26T22:23:38.671Z","categories":["5564f26b1fd04c0d00dc9aae","556741d17acd550d0075eaca","556741d87acd550d0075eacb","556742f87acd550d0075ead1","556781cd6976ef0d0099c545","5568d666d33aad0d00ec8d2e","557f6b2d38249b0d00d0d12b","55b67be9c2e909190073ed38","564e56c601e80e0d00396684","56731b714b2a680d00524daf","573612ac652bd80e00a90027","57365e2cf8ebd31700769f50","57366131f8ebd31700769f58","573b93514e029d19000b8669","573bbfdb7ac6f6170033bd35"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"556741d17acd550d0075eaca","version":"5564f26a1fd04c0d00dc9aad","pages":["556741e97acd550d0075eace","5567445f77c15523002fd57f"],"project":"5564f26a1fd04c0d00dc9aaa","__v":2,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-05-28T16:26:57.533Z","from_sync":false,"order":1,"slug":"security","title":"Security"},"__v":40,"project":"5564f26a1fd04c0d00dc9aaa","updates":["55dcb6efd7d2130d0001f380"],"next":{"pages":[],"description":""},"createdAt":"2015-05-28T16:37:51.137Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"The device permissions in Meshblu, are similar to permissions in *nix based systems. The whitelists are all represented as arrays of UUIDs. The following permissions are supported:\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"body\": \"The absence of a whitelist indicates the property is open. To deny access to all devices, set the property to `[]`, e.g. `discoverWhitelist: [ ]`\",\n  \"title\": \"Missing Property\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"Open Whitelist\",\n  \"body\": \"To enable access for all devices, set the property to `*`, e.g. `receiveWhitelist: [\\\"*\\\"]`\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Owner\"\n}\n[/block]\nThe `owner` property of a Meshblu device has special meaning. The UUID listed in the `owner` property gives that device full access to all whitelists.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Deprecation Warning\",\n  \"body\": \"The special meaning of the `owner` property will be removed in a future version of Meshblu. Whitelists will be the exclusive means of controlling device access.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"configureWhitelist\"\n}\n[/block]\nAdding an Updater device's UUID to a device's `configureWhitelist` will make that device configurable to the Finder. This means that the Updater may update everything about the device, including the device's whitelist. This is the Unix equivalent of root access. \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"uuid\\\":\\\"ad698900-2546-11e3-87fb-c560cb0ca47b\\\",\\n  \\\"configureWhitelist\\\":[\\n    \\\"f86e3500-a32d-4914-ab54-d402571f67fc\\\",\\n    \\\"0c81df27-de55-4e57-a17f-da0d62a99e3d\\\"\\n  ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"example-device.json\"\n    }\n  ]\n}\n[/block]\n# discoverWhitelist\n\nAdding a Finder device's UUID to a device's `discoverWhitelist` will make that device visible to the Finder. This means that the Finder can retrieve the device directly by UUID and that the device will show up when Finder searches for devices.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"uuid\\\":\\\"4c2ef860-2d0d-46ab-b5b3-b24cca0d1f48\\\",\\n  \\\"discoverWhitelist\\\":[\\n    \\\"f86e3500-a32d-4914-ab54-d402571f67fc\\\",\\n    \\\"0c81df27-de55-4e57-a17f-da0d62a99e3d\\\"\\n  ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"example-device.json\"\n    }\n  ]\n}\n[/block]\n# receiveWhitelist\n\nAdding a Receiver device's UUID to a device's `receiveWhitelist` will allow the Receiver to subscribe to that device's broadcast messages.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"uuid\\\":\\\"ad698900-2546-11e3-87fb-c560cb0ca47b\\\",\\n  \\\"receiveWhitelist\\\":[\\n    \\\"f86e3500-a32d-4914-ab54-d402571f67fc\\\",\\n    \\\"0c81df27-de55-4e57-a17f-da0d62a99e3d\\\"\\n  ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"example-device.json\"\n    }\n  ]\n}\n[/block]\n# sendWhitelist\n\nAdding a Sender device's UUID to a device's `sendWhitelist` will allow the Sender to send direct messages to that device.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"uuid\\\":\\\"ad698900-2546-11e3-87fb-c560cb0ca47b\\\",\\n  \\\"sendWhitelist\\\":[\\n    \\\"f86e3500-a32d-4914-ab54-d402571f67fc\\\",\\n    \\\"0c81df27-de55-4e57-a17f-da0d62a99e3d\\\"\\n  ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"example-device.json\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"whitelists","type":"basic","title":"Whitelists (DEPRECATED)"}

Whitelists (DEPRECATED)


The device permissions in Meshblu, are similar to permissions in *nix based systems. The whitelists are all represented as arrays of UUIDs. The following permissions are supported: [block:callout] { "type": "danger", "body": "The absence of a whitelist indicates the property is open. To deny access to all devices, set the property to `[]`, e.g. `discoverWhitelist: [ ]`", "title": "Missing Property" } [/block] [block:callout] { "type": "success", "title": "Open Whitelist", "body": "To enable access for all devices, set the property to `*`, e.g. `receiveWhitelist: [\"*\"]`" } [/block] [block:api-header] { "type": "basic", "title": "Owner" } [/block] The `owner` property of a Meshblu device has special meaning. The UUID listed in the `owner` property gives that device full access to all whitelists. [block:callout] { "type": "warning", "title": "Deprecation Warning", "body": "The special meaning of the `owner` property will be removed in a future version of Meshblu. Whitelists will be the exclusive means of controlling device access." } [/block] [block:api-header] { "type": "basic", "title": "configureWhitelist" } [/block] Adding an Updater device's UUID to a device's `configureWhitelist` will make that device configurable to the Finder. This means that the Updater may update everything about the device, including the device's whitelist. This is the Unix equivalent of root access. [block:code] { "codes": [ { "code": "{\n \"uuid\":\"ad698900-2546-11e3-87fb-c560cb0ca47b\",\n \"configureWhitelist\":[\n \"f86e3500-a32d-4914-ab54-d402571f67fc\",\n \"0c81df27-de55-4e57-a17f-da0d62a99e3d\"\n ]\n}", "language": "json", "name": "example-device.json" } ] } [/block] # discoverWhitelist Adding a Finder device's UUID to a device's `discoverWhitelist` will make that device visible to the Finder. This means that the Finder can retrieve the device directly by UUID and that the device will show up when Finder searches for devices. [block:code] { "codes": [ { "code": "{\n \"uuid\":\"4c2ef860-2d0d-46ab-b5b3-b24cca0d1f48\",\n \"discoverWhitelist\":[\n \"f86e3500-a32d-4914-ab54-d402571f67fc\",\n \"0c81df27-de55-4e57-a17f-da0d62a99e3d\"\n ]\n}", "language": "json", "name": "example-device.json" } ] } [/block] # receiveWhitelist Adding a Receiver device's UUID to a device's `receiveWhitelist` will allow the Receiver to subscribe to that device's broadcast messages. [block:code] { "codes": [ { "code": "{\n \"uuid\":\"ad698900-2546-11e3-87fb-c560cb0ca47b\",\n \"receiveWhitelist\":[\n \"f86e3500-a32d-4914-ab54-d402571f67fc\",\n \"0c81df27-de55-4e57-a17f-da0d62a99e3d\"\n ]\n}", "language": "json", "name": "example-device.json" } ] } [/block] # sendWhitelist Adding a Sender device's UUID to a device's `sendWhitelist` will allow the Sender to send direct messages to that device. [block:code] { "codes": [ { "code": "{\n \"uuid\":\"ad698900-2546-11e3-87fb-c560cb0ca47b\",\n \"sendWhitelist\":[\n \"f86e3500-a32d-4914-ab54-d402571f67fc\",\n \"0c81df27-de55-4e57-a17f-da0d62a99e3d\"\n ]\n}", "language": "json", "name": "example-device.json" } ] } [/block]