├── Dockerfile ├── README.md └── LICENSE /Dockerfile: -------------------------------------------------------------------------------- 1 | ARG ALPINE_VERSION=3.10 2 | 3 | FROM alpine:${ALPINE_VERSION} as tools 4 | 5 | ARG GRPC_TOOLS_VERSION=0.2.6 6 | 7 | RUN apk --no-cache add git && \ 8 | git clone https://github.com/hyperledger/fabric-protos.git /tmp/fabric-protos && \ 9 | rm -Rf /tmp/fabric-protos/.git* /tmp/fabric-protos/ci && \ 10 | find /tmp/fabric-protos -type f ! -name '*.proto' -exec rm {} \; 11 | 12 | ADD https://github.com/bradleyjkemp/grpc-tools/releases/download/v${GRPC_TOOLS_VERSION}/grpc-tools_${GRPC_TOOLS_VERSION}_Linux_amd64.zip /tmp 13 | RUN unzip -d /tmp /tmp/grpc-tools_${GRPC_TOOLS_VERSION}_Linux_amd64.zip 14 | 15 | FROM alpine:${ALPINE_VERSION} 16 | 17 | RUN apk --no-cache add libc6-compat 18 | 19 | RUN addgroup -g 500 proxy && adduser -u 500 -D -h /home/proxy -G proxy proxy 20 | 21 | USER proxy 22 | 23 | WORKDIR /home/proxy 24 | 25 | COPY --from=tools --chown=500:500 /tmp/grpc-dump ./grpc-dump 26 | COPY --from=tools --chown=500:500 /tmp/fabric-protos/ ./protos/ 27 | 28 | # Chaincode as a server 29 | CMD ["/home/proxy/grpc-dump", "-interface=0.0.0.0", "-port=9999", "-destination=fabcar.example.com:9999", "-proto_roots=/home/proxy/protos", "-log_level=debug"] 30 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # fabric-peer-proxy 2 | 3 | grpc-dump proxy in docker to intercept Fabric peer gRPC messages 4 | 5 | ## Build 6 | 7 | ``` 8 | docker build -t hyperledgendary/fabric-proxy . 9 | ``` 10 | 11 | ## Usage 12 | 13 | Seemed to work with the [fabcar chaincode as a server sample](https://github.com/hyperledger/fabric-samples/tree/master/chaincode/fabcar/external). 14 | 15 | Use the address of proxy in the `connection.json` configuration file instead of the chaincode server. 16 | Start the proxy as well when starting the chaincode server, e.g. 17 | 18 | ``` 19 | docker run -it --rm --name proxy.example.com --hostname proxy.example.com -p 9999:9999 --network=small_fabricdev hyperledgendary/fabric-proxy 20 | docker run -it --rm --name fabcar.example.com --hostname fabcar.example.com --env-file chaincode.env --network=small_fabricdev hyperledger/fabcar-sample 21 | ``` 22 | 23 | **Note** Due to a [grpc-dump issue](https://github.com/bradleyjkemp/grpc-tools/issues/6) the gRPC connection must finish before any of the messages are displayed. Just stopping and restarting the chaincode server should work. 24 | 25 | ## Decoding messages 26 | 27 | Unfortunately Fabric gRPC messages include various `payload` blobs which grpc-dump is not able to decode automatically, but there should be enough information to decode them using the [configtxlator](https://hyperledger-fabric.readthedocs.io/en/release-2.0/commands/configtxlator.html) command. For example: 28 | 29 | ``` 30 | { 31 | "message_origin": "server", 32 | "raw_message": "CA4aAwoBASJAZjE2MzViNTJjNjg5NGZlODk1Nzg4ZjY4ZWRkNzQyNWE1NjI0N2ZhNGZlMDVmMTlmN2YwMDQ5NjE1OTk4MjhiYjoMc21hbGxjaGFubmVs", 33 | "message": { 34 | "type": "GET_STATE_BY_RANGE", 35 | "payload": "CgEB", 36 | "txid": "f1635b52c6894fe895788f68edd7425a56247fa4fe05f19f7f004961599828bb", 37 | "channelId": "smallchannel" 38 | }, 39 | "timestamp": "2020-07-10T15:36:55.890475672Z" 40 | }, 41 | ``` 42 | 43 | Use [jq](https://stedolan.github.io/jq/) and the `base64 --decode` command to extract the payload you're interested in. Then decode it using `configtxlator`, e.g. for the example above: 44 | 45 | ``` 46 | configtxlator proto_decode --type=protos.GetStateByRange --input=payload.bin 47 | ``` 48 | 49 | Use the [fabric-protos](https://github.com/hyperledger/fabric-protos) project to find the correct message for the `--type` argument. The decoded `GET_STATE_BY_RANGE` payload should look like this: 50 | 51 | ``` 52 | { 53 | "collection": "", 54 | "endKey": "", 55 | "metadata": null, 56 | "startKey": "\u0001" 57 | } 58 | ``` 59 | 60 | ## Future 61 | 62 | Making this work with "normal" chaincode, or with a client app could be useful. 63 | 64 | ## Misc 65 | 66 | ``` 67 | docker run --rm -it --entrypoint=/bin/sh hyperledgendary/fabric-proxy 68 | ``` 69 | 70 | ``` 71 | { 72 | "message_origin": "client", 73 | "raw_message": "CAUaDgoMcXVlcnlBbGxDYXJzIkBmMTYzNWI1MmM2ODk0ZmU4OTU3ODhmNjhlZGQ3NDI1YTU2MjQ3ZmE0ZmUwNWYxOWY3ZjAwNDk2MTU5OTgyOGJiKswICoAICtsHCmwIAxoMCJeWovgFENeJ3aUDIgxzbWFsbGNoYW5uZWwqQGYxNjM1YjUyYzY4OTRmZTg5NTc4OGY2OGVkZDc0MjVhNTYyNDdmYTRmZTA1ZjE5ZjdmMDA0OTYxNTk5ODI4YmI6ChIIEgZmYWJjYXIS6gYKzQYKDkh1bWJvbGR0T3JnTVNQEroGLS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUNOVENDQWR1Z0F3SUJBZ0lRSVplTTlaZ1lka3NDVUlYZ3hkeDk3REFLQmdncWhrak9QUVFEQWpCN01Rc3cKQ1FZRFZRUUdFd0pWVXpFVE1CRUdBMVVFQ0JNS1EyRnNhV1p2Y201cFlURVdNQlFHQTFVRUJ4TU5VMkZ1SUVaeQpZVzVqYVhOamJ6RWRNQnNHQTFVRUNoTVVhSFZ0WW05c1pIUXVaWGhoYlhCc1pTNWpiMjB4SURBZUJnTlZCQU1UCkYyTmhMbWgxYldKdmJHUjBMbVY0WVcxd2JHVXVZMjl0TUI0WERUSXdNRGN4TURFME1qa3dNRm9YRFRNd01EY3cKT0RFME1qa3dNRm93YnpFTE1Ba0dBMVVFQmhNQ1ZWTXhFekFSQmdOVkJBZ1RDa05oYkdsbWIzSnVhV0V4RmpBVQpCZ05WQkFjVERWTmhiaUJHY21GdVkybHpZMjh4RGpBTUJnTlZCQXNUQldGa2JXbHVNU013SVFZRFZRUUREQnBCClpHMXBia0JvZFcxaWIyeGtkQzVsZUdGdGNHeGxMbU52YlRCWk1CTUdCeXFHU000OUFnRUdDQ3FHU000OUF3RUgKQTBJQUJJeUJqM1FMYVJrM04yK29TdmFDZ0lGK1pSWlJFNS96ZlljNXY5UnNqWWxNZWMwVE5GbmQvTkwzcnRGTApxZUN2TjgzYjNRdDZTT0RsZjZDQkxRbUZuTmlqVFRCTE1BNEdBMVVkRHdFQi93UUVBd0lIZ0RBTUJnTlZIUk1CCkFmOEVBakFBTUNzR0ExVWRJd1FrTUNLQUlPbHFzSXNoN0RzRTFWYkpUdkRobGF1K2lFcERYTkdPelhuYVR5SnoKVm8yaU1Bb0dDQ3FHU000OUJBTUNBMGdBTUVVQ0lRRHltdjFpUXEwR0ttQkxrekZYWlRJemdOZnNlTkRlU2kxMgpyT2kyQzVUczVnSWdTYlZEREFYV0dKQzJMQjRUWnVJNVRPRG9lbGQ3K0dlNnpwdmxaaGFSa3VrPQotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tChIY6GPIamn6YbiU9bDq6xK9BUey+HZNTOkMEiAKHgocCAESCBIGZmFiY2FyGg4KDHF1ZXJ5QWxsQ2FycxJHMEUCIQCNLA7Z31pWm03cD5NsY4FHUktPVfuqVmzD6YsSoaggZgIgPMT7VZUoFF0Y8tkB4gyC4za65mZ2UpMBc7g4T0tzycg6DHNtYWxsY2hhbm5lbA==", 74 | "message": { 75 | "type": "TRANSACTION", 76 | "payload": "CgxxdWVyeUFsbENhcnM=", 77 | "txid": "f1635b52c6894fe895788f68edd7425a56247fa4fe05f19f7f004961599828bb", 78 | "proposal": { 79 | "proposalBytes": "CtsHCmwIAxoMCJeWovgFENeJ3aUDIgxzbWFsbGNoYW5uZWwqQGYxNjM1YjUyYzY4OTRmZTg5NTc4OGY2OGVkZDc0MjVhNTYyNDdmYTRmZTA1ZjE5ZjdmMDA0OTYxNTk5ODI4YmI6ChIIEgZmYWJjYXIS6gYKzQYKDkh1bWJvbGR0T3JnTVNQEroGLS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUNOVENDQWR1Z0F3SUJBZ0lRSVplTTlaZ1lka3NDVUlYZ3hkeDk3REFLQmdncWhrak9QUVFEQWpCN01Rc3cKQ1FZRFZRUUdFd0pWVXpFVE1CRUdBMVVFQ0JNS1EyRnNhV1p2Y201cFlURVdNQlFHQTFVRUJ4TU5VMkZ1SUVaeQpZVzVqYVhOamJ6RWRNQnNHQTFVRUNoTVVhSFZ0WW05c1pIUXVaWGhoYlhCc1pTNWpiMjB4SURBZUJnTlZCQU1UCkYyTmhMbWgxYldKdmJHUjBMbVY0WVcxd2JHVXVZMjl0TUI0WERUSXdNRGN4TURFME1qa3dNRm9YRFRNd01EY3cKT0RFME1qa3dNRm93YnpFTE1Ba0dBMVVFQmhNQ1ZWTXhFekFSQmdOVkJBZ1RDa05oYkdsbWIzSnVhV0V4RmpBVQpCZ05WQkFjVERWTmhiaUJHY21GdVkybHpZMjh4RGpBTUJnTlZCQXNUQldGa2JXbHVNU013SVFZRFZRUUREQnBCClpHMXBia0JvZFcxaWIyeGtkQzVsZUdGdGNHeGxMbU52YlRCWk1CTUdCeXFHU000OUFnRUdDQ3FHU000OUF3RUgKQTBJQUJJeUJqM1FMYVJrM04yK29TdmFDZ0lGK1pSWlJFNS96ZlljNXY5UnNqWWxNZWMwVE5GbmQvTkwzcnRGTApxZUN2TjgzYjNRdDZTT0RsZjZDQkxRbUZuTmlqVFRCTE1BNEdBMVVkRHdFQi93UUVBd0lIZ0RBTUJnTlZIUk1CCkFmOEVBakFBTUNzR0ExVWRJd1FrTUNLQUlPbHFzSXNoN0RzRTFWYkpUdkRobGF1K2lFcERYTkdPelhuYVR5SnoKVm8yaU1Bb0dDQ3FHU000OUJBTUNBMGdBTUVVQ0lRRHltdjFpUXEwR0ttQkxrekZYWlRJemdOZnNlTkRlU2kxMgpyT2kyQzVUczVnSWdTYlZEREFYV0dKQzJMQjRUWnVJNVRPRG9lbGQ3K0dlNnpwdmxaaGFSa3VrPQotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tChIY6GPIamn6YbiU9bDq6xK9BUey+HZNTOkMEiAKHgocCAESCBIGZmFiY2FyGg4KDHF1ZXJ5QWxsQ2Fycw==", 80 | "signature": "MEUCIQCNLA7Z31pWm03cD5NsY4FHUktPVfuqVmzD6YsSoaggZgIgPMT7VZUoFF0Y8tkB4gyC4za65mZ2UpMBc7g4T0tzycg=" 81 | }, 82 | "channelId": "smallchannel" 83 | }, 84 | "timestamp": "2020-07-10T15:36:55.890159807Z" 85 | } 86 | ``` 87 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------