|
| 1 | +# <a name="title"></a> Rot13 Chef Cookbook |
| 2 | + |
| 3 | +[](http://travis-ci.org/ut-cookbooks/rot13) |
| 4 | + |
| 5 | +## <a name="description"></a> Description |
| 6 | + |
| 7 | +Chef cookbook for securing sensitive payloads on nodes using a classic Caesar cipher. You know, 'cause it had to be done. |
| 8 | + |
| 9 | +* Source Code: https://github.com/ut-cookbooks/rot13 |
| 10 | +* Community Site: http://community.opscode.com/cookbooks/rot13 |
| 11 | + |
| 12 | +## <a name="usage"></a> Usage |
| 13 | + |
| 14 | +Simply add a `depends "rot13"` in one of your cookbooks or include `recipe[rot13]` in your run\_list and you will have access to the `rot13_vault` [lwrp](#lwrps). |
| 15 | + |
| 16 | +## <a name="requirements"></a> Requirements |
| 17 | + |
| 18 | +### <a name="requirements-chef"></a> Chef |
| 19 | + |
| 20 | +Tested on 11.10.4 but newer and older versions should work just fine. |
| 21 | +File an [issue][issues] if this isn't the case. |
| 22 | + |
| 23 | +### <a name="requirements-platform"></a> Platform |
| 24 | + |
| 25 | +The following platforms have been tested with this cookbook, meaning that the |
| 26 | +recipes run on these platforms without error: |
| 27 | + |
| 28 | +* ubuntu (12.04) |
| 29 | +* centos (6.4) |
| 30 | + |
| 31 | +Please [report][issues] any additional platforms so they can be added. |
| 32 | + |
| 33 | +### <a name="requirements-cookbooks"></a> Cookbooks |
| 34 | + |
| 35 | +This cookbook has **no** cookbook dependencies. |
| 36 | + |
| 37 | +## <a name="recipes"></a> Recipes |
| 38 | + |
| 39 | +### <a name="recipes-default"></a> default |
| 40 | + |
| 41 | +This recipe, gloriously, does nothing. |
| 42 | + |
| 43 | +## <a name="attributes"></a> Attributes |
| 44 | + |
| 45 | +This cookbook depends on **no** attributes. |
| 46 | + |
| 47 | +## <a name="lwrps"></a> Resources and Providers |
| 48 | + |
| 49 | +### <a name="lwrps-rot13-vault"></a> rot13\_vault |
| 50 | + |
| 51 | +### <a name="lwrps-rot13-vault-actions"></a> Actions |
| 52 | + |
| 53 | +| Action | Description | Default | |
| 54 | +|--------|---------------------------|---------| |
| 55 | +| create | Creates the encoded file. | Yes | |
| 56 | + |
| 57 | +### <a name="lwrps-rot13-vault-attributes"></a> Attributes |
| 58 | + |
| 59 | +| Attribute | Description | Default Value | |
| 60 | +|-----------|---------------------------|---------------| |
| 61 | +| path | **Name attribute:** The path for the file. | `nil` | |
| 62 | +| owner | The owner of the file. | `nil` | |
| 63 | +| group | The group ownership of the file. | `nil` | |
| 64 | +| mode | The permissions of the file. | `nil` | |
| 65 | +| payload | The content that is to be encoded in the file. | `nil` | |
| 66 | + |
| 67 | +#### <a name="lwrps-rot13-vault-examples"></a> Examples |
| 68 | + |
| 69 | + rot13_vault "lockdown" do |
| 70 | + path "/etc/private/nopeek" |
| 71 | + owner "root" |
| 72 | + group "root" |
| 73 | + mode "0400" |
| 74 | + payload "please don't decode this" |
| 75 | + end |
| 76 | + |
| 77 | + rot13_vault "/tmp/nothin" do |
| 78 | + payload <<-PAYLOAD |
| 79 | + once upon a time, ... |
| 80 | + PAYLOAD |
| 81 | + end |
| 82 | + |
| 83 | +## <a name="development"></a> Development |
| 84 | + |
| 85 | +* Source hosted at [GitHub][repo] |
| 86 | +* Report issues/Questions/Feature requests on [GitHub Issues][issues] |
| 87 | + |
| 88 | +Pull requests are very welcome! Make sure your patches are well tested. |
| 89 | +Ideally create a topic branch for every separate change you make. |
| 90 | + |
| 91 | +## <a name="license"></a> License and Author |
| 92 | + |
| 93 | +Author:: [Fletcher Nichol ][fnichol] ( <[email protected]>) [](http://coderwall.com/fnichol) |
| 94 | + |
| 95 | +Copyright 2014, Fletcher Nichol |
| 96 | + |
| 97 | +Licensed under the Apache License, Version 2.0 (the "License"); |
| 98 | +you may not use this file except in compliance with the License. |
| 99 | +You may obtain a copy of the License at |
| 100 | + |
| 101 | + http://www.apache.org/licenses/LICENSE-2.0 |
| 102 | + |
| 103 | +Unless required by applicable law or agreed to in writing, software |
| 104 | +distributed under the License is distributed on an "AS IS" BASIS, |
| 105 | +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 106 | +See the License for the specific language governing permissions and |
| 107 | +limitations under the License. |
| 108 | + |
| 109 | +[fnichol]: https://github.com/fnichol |
| 110 | +[repo]: https://github.com/ut-cookbooks/rot13 |
| 111 | +[issues]: https://github.com/ut-cookbooks/rot13/issues |
0 commit comments