{"id":23853578,"url":"https://github.com/shaqian/react-native-ssh-sftp","last_synced_at":"2025-09-08T00:32:08.998Z","repository":{"id":40398896,"uuid":"130545523","full_name":"shaqian/react-native-ssh-sftp","owner":"shaqian","description":"SSH/SFTP client for React Native","archived":false,"fork":false,"pushed_at":"2023-01-25T11:17:07.000Z","size":3994,"stargazers_count":66,"open_issues_count":31,"forks_count":53,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-08-30T16:41:55.754Z","etag":null,"topics":["react","react-native","sftp","shell","ssh"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/react-native-ssh-sftp","language":"Objective-C","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/shaqian.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-04-22T07:34:54.000Z","updated_at":"2025-06-15T15:51:51.000Z","dependencies_parsed_at":"2023-02-14T07:00:43.447Z","dependency_job_id":null,"html_url":"https://github.com/shaqian/react-native-ssh-sftp","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/shaqian/react-native-ssh-sftp","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shaqian%2Freact-native-ssh-sftp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shaqian%2Freact-native-ssh-sftp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shaqian%2Freact-native-ssh-sftp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shaqian%2Freact-native-ssh-sftp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shaqian","download_url":"https://codeload.github.com/shaqian/react-native-ssh-sftp/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shaqian%2Freact-native-ssh-sftp/sbom","scorecard":{"id":816297,"data":{"date":"2025-08-11","repo":{"name":"github.com/shaqian/react-native-ssh-sftp","commit":"e25d09c2a67c1019d07872fcce51da37d91d6077"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.7,"checks":[{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":1,"reason":"Found 2/17 approved changesets -- score normalized to 1","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Binary-Artifacts","score":9,"reason":"binaries present in source code","details":["Warn: binary detected: example/android/gradle/wrapper/gradle-wrapper.jar:1"],"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 4 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"88 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-6chw-6frg-f759","Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-cwfw-4gq5-mrqx","Warn: Project is vulnerable to: GHSA-g95f-p29q-9xw4","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-rq8g-5pc5-wrhr","Warn: Project is vulnerable to: GHSA-hr2v-3952-633q","Warn: Project is vulnerable to: GHSA-h6ch-v84p-w6p9","Warn: Project is vulnerable to: GHSA-qrmc-fj45-qfc2","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3","Warn: Project is vulnerable to: MAL-2023-462","Warn: Project is vulnerable to: GHSA-xf7w-r453-m56c","Warn: Project is vulnerable to: GHSA-q42p-pg8m-cqh6","Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9","Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f","Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p","Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv","Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8","Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65","Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh","Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44","Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988","Warn: Project is vulnerable to: GHSA-44pw-h2cw-w3vq","Warn: Project is vulnerable to: GHSA-jp4x-w63m-7wgm","Warn: Project is vulnerable to: GHSA-c429-5p7v-vgjp","Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj","Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37","Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546","Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx","Warn: Project is vulnerable to: GHSA-896r-f27r-55mw","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695","Warn: Project is vulnerable to: GHSA-fvqr-27wr-82fm","Warn: Project is vulnerable to: GHSA-4xc9-xhrj-v574","Warn: Project is vulnerable to: GHSA-x5rq-j2xg-h7qm","Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw","Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-4xcv-9jjx-gfj3","Warn: Project is vulnerable to: GHSA-f9cm-qmx5-m98h","Warn: Project is vulnerable to: GHSA-7wpw-2hjm-89gp","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-gwg9-rgvj-4h5j","Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g","Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p","Warn: Project is vulnerable to: GHSA-6394-6h9h-cfjg","Warn: Project is vulnerable to: GHSA-76c9-3jph-rj3q","Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9","Warn: Project is vulnerable to: GHSA-4cpg-3vgw-4877","Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp","Warn: Project is vulnerable to: GHSA-6g33-f262-xjp4","Warn: Project is vulnerable to: GHSA-rxrc-rgv4-jpvx","Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg","Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p","Warn: Project is vulnerable to: GHSA-g4rg-993r-mgx7","Warn: Project is vulnerable to: GHSA-gff7-g5r8-mg8m","Warn: Project is vulnerable to: GHSA-2m39-62fm-q8r3","Warn: Project is vulnerable to: GHSA-mf6x-7mm4-x2g7","Warn: Project is vulnerable to: GHSA-j44m-qm6p-hp7m","Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9","Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh","Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36","Warn: Project is vulnerable to: GHSA-52f5-9888-hmc6","Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-662x-fhqg-9p8v","Warn: Project is vulnerable to: GHSA-394c-5j6w-4xmx","Warn: Project is vulnerable to: GHSA-78cj-fxph-m83p","Warn: Project is vulnerable to: GHSA-fhg7-m89q-25r3","Warn: Project is vulnerable to: GHSA-5v72-xg48-5rpm","Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q","Warn: Project is vulnerable to: GHSA-h6q6-9hqw-rwfv","Warn: Project is vulnerable to: GHSA-5fg8-2547-mr8q","Warn: Project is vulnerable to: GHSA-crh6-fp67-6883","Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh","Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-23T14:20:19.382Z","repository_id":40398896,"created_at":"2025-08-23T14:20:19.382Z","updated_at":"2025-08-23T14:20:19.382Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274117110,"owners_count":25225098,"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","status":"online","status_checked_at":"2025-09-07T02:00:09.463Z","response_time":67,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["react","react-native","sftp","shell","ssh"],"created_at":"2025-01-02T23:18:02.476Z","updated_at":"2025-09-08T00:32:08.387Z","avatar_url":"https://github.com/shaqian.png","language":"Objective-C","funding_links":[],"categories":[],"sub_categories":[],"readme":"# react-native-ssh-sftp\n\nSSH and SFTP client library for React Native.\n\n## Installation\n\n```\nnpm install react-native-ssh-sftp --save\nreact-native link react-native-ssh-sftp\n```\n\n### iOS (only)\n\nNMSSH is required for iOS.\n\n1. Initialize Pod:\n\t```\n\tcd ios\n\tpod init\n\t```\n2. Open Podfile and add:\n\t```\n\ttarget '[your project's name]' do\n\t\tpod 'NMSSH', '2.2.8'\n\tend\n\t```\n3. Install Pod:\n\t```\n\tpod install\n\t```\n\n### Manual Link\n\n#### iOS\n\n1. In XCode, in the project navigator, right click `Libraries` ➜ `Add Files to [your project's name]`\n2. Go to `node_modules` ➜ `react-native-ssh-sftp` and add `RNSSHClient.xcodeproj`\n3. In XCode, in the project navigator, select your project. Add `libRNSSHClient.a` to your project's `Build Phases` ➜ `Link Binary With Libraries`\n\n#### Android\n\n1. Open up `android/app/src/main/java/[...]/MainActivity.java`\n\t\t- Add `import com.reactlibrary.RNSshClientPackage;` to the imports at the top of the file\n\t\t- Add `new RNSshClientPackage()` to the list returned by the `getPackages()` method\n2. Append the following lines to `android/settings.gradle`:\n  \t```\n  \tinclude ':react-native-ssh-sftp'\n  \tproject(':react-native-ssh-sftp').projectDir = new File(rootProject.projectDir, \t'../node_modules/react-native-ssh-sftp/android')\n  \t```\n3. Insert the following lines inside the dependencies block in `android/app/build.gradle`:\n  \t```\n    compile project(':react-native-ssh-sftp')\n  \t```\n\n## Demo\n\n![example](https://raw.githubusercontent.com/shaqian/react-native-ssh-sftp/master/example.gif)\n\n- This library is also used in iOS app PiHelper. \n\n\u003ca href=\"https://itunes.apple.com/app/pihelper/id1369930932\"\u003e\u003cimg src=\"https://is4-ssl.mzstatic.com/image/thumb/Purple128/v4/ba/5b/59/ba5b592a-5446-1c21-6703-3eb3fb25007e/AppIcon-1x_U007emarketing-85-220-9.png/246x0w.jpg\" align=\"left\" height=\"75\" width=\"75\" \u003e\u003c/a\u003e\n\u003cbr /\u003e\n\u003cbr /\u003e\n\u003cbr /\u003e\n\n## Run demo\n\n### iOS\n```\ncd example\ncd ios\npod install\ncd ..\nnpm install\nreact-native run-ios\n```\n\n### Android\n```\ncd example\nnpm install\nreact-native run-android\n```\n\n## Usage\n\n### Create a client using password authentication\n```javascript\nimport SSHClient from 'react-native-ssh-sftp';\n\nlet client = new SSHClient('10.0.0.10', 22, 'user', 'password', (error) =\u003e {\n  if (error)\n    console.warn(error);\n});\n```\n\n### Create a client using public key authentication\n```javascript\nimport SSHClient from 'react-native-ssh-sftp';\n\nlet client = new SSHClient('10.0.0.10', 22, 'user', {privateKey: '-----BEGIN RSA......'}, (error) =\u003e {\n  if (error)\n    console.warn(error);\n});\n```\n\n- Public key authentication also supports:\n```\n{privateKey: '-----BEGIN RSA......'}\n{privateKey: '-----BEGIN RSA......', publicKey: 'ssh-rsa AAAAB3NzaC1yc2EA......'}\n{privateKey: '-----BEGIN RSA......', publicKey: 'ssh-rsa AAAAB3NzaC1yc2EA......', passphrase: 'Password'}\n```\n\n### Close client\n```javascript\nclient.disconnect();\n```\n\n### Execute SSH command\n```javascript\nvar command = 'ls -l';\nclient.execute(command, (error, output) =\u003e {\n  if (error)\n    console.warn(error);\n  if (output)\n    console.warn(output);\n});\n```\n\n### Shell\n\n#### Start shell: \n- Supported ptyType: vanilla, vt100, vt102, vt220, ansi, xterm\n```javascript\nvar ptyType = 'vanilla';\nclient.startShell(ptyType, (error) =\u003e {\n  if (error)\n    console.warn(error);\n});\n```\n\n#### Read from shell:\n```javascript\nclient.on('Shell', (event) =\u003e {\n  if (event)\n    console.warn(event);\n});\n```\n\n#### Write to shell: \n```javascript\nvar str = 'ls -l\\n';\nclient.writeToShell(str, (error) =\u003e {\n  if (error) \n    console.warn(error);\n});\n```\n\n#### Close shell: \n```javascript\nclient.closeShell();\n```\n\n### SFTP\n\n#### Connect SFTP\n```javascript\nclient.connectSFTP((error) =\u003e {\n  if (error)\n    console.warn(error);\n});\n```\n\n#### List directory: \n```javascript\nvar path = '.';\nclient.sftpLs(path, (error, response) =\u003e {\n  if (error)\n    console.warn(error);\n  if (response)\n    console.warn(response);\n});\n```\n\n#### Create directory: \n```javascript\nclient.sftpMkdir('dirName', (error) =\u003e {\n  if (error)\n    console.warn(error);\n});\n```\n\n#### Rename file or directory: \n```javascript\nclient.sftpRename('oldName', 'newName', (error) =\u003e {\n  if (error)\n    console.warn(error);\n});\n```\n\n#### Remove directory: \n```javascript\nclient.sftpRmdir('dirName', (error) =\u003e {\n  if (error)\n    console.warn(error);\n});\n```\n\n#### Remove file: \n```javascript\nclient.sftpRm('fileName', (error) =\u003e {\n  if (error)\n    console.warn(error);\n});\n```\n\n#### Download file: \n```javascript\nclient.sftpDownload('[path-to-remote-file]', '[path-to-local-direcotry]', (error, downloadedFilePath) =\u003e {\n  if (error)\n    console.warn(error);\n  if (downloadedFilePath)\n    console.warn(downloadedFilePath);\n});\n\n// Downlowd progress\nclient.on('DownloadProgress', (event) =\u003e {\n  console.warn(event);\n});\n\n// Cancel download:\nclient.sftpCancelDownload();\n```\n\n#### Upload file: \n```javascript\nclient.sftpUpload('[path-to-local-file]', '[path-to-remote-directory]', (error) =\u003e {\n  if (error)\n    console.warn(error);\n});\n\n// Upload progress\nclient.on('UploadProgress', (event) =\u003e {\n  console.warn(event);\n});\n\n// Cancel upload:\nclient.sftpCancelUpload();\n```\n\n#### Close SFTP: \n```javascript\nclient.disconnectSFTP();\n```\n\n## Credits\n\n* iOS SSH library: [NMSSH](https://github.com/NMSSH/NMSSH)\n* Android SSH library: [JSch](http://www.jcraft.com/jsch/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshaqian%2Freact-native-ssh-sftp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshaqian%2Freact-native-ssh-sftp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshaqian%2Freact-native-ssh-sftp/lists"}